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

github-automation-metabased39d8c5800ac
diff --git a/docs/api.json b/docs/api.json
index c30c11f55f4..c93a651295f 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -1142,829 +1142,406 @@
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-expression"
} ]
},
- "metabase-enterprise.agent-api.api.column-metadata" : {
- "description" : "Metadata for a single result column.",
+ "metabase-enterprise.data-studio.api.table.publish-tables-response" : {
+ "description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",
"type" : "object",
"properties" : {
- "base_type" : {
- "type" : "string"
- },
- "display_name" : {
- "type" : "string"
- },
- "effective_type" : {
+ "target_collection" : {
"oneOf" : [ {
- "type" : "string"
+ "description" : "value must be an instance of :model/Collection"
}, {
"type" : "null"
} ]
- },
- "name" : {
- "type" : "string"
}
},
- "required" : [ "name", "base_type", "display_name" ]
+ "required" : [ "target_collection" ]
},
- "metabase-enterprise.agent-api.api.construct-query-metric-request" : {
- "description" : "Request schema for constructing a query from a metric.\n Only supports filters and group_by (aggregation is defined by the metric).",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "filters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"
- }
- }, {
- "type" : "null"
- } ]
- },
- "group_by" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.group-by"
- }
- }, {
- "type" : "null"
- } ]
- },
- "metric_id" : {
+ "metabase-enterprise.data-studio.api.table.table-selectors" : {
+ "type" : "object",
+ "properties" : {
+ "database_ids" : {
+ "type" : "array",
+ "items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
- "required" : [ "metric_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.agent-api.api.construct-query-request" : {
- "description" : "Request schema for /v1/construct-query. Accepts either table_id or metric_id.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.construct-query-table-request"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.construct-query-metric-request"
- } ]
- },
- "metabase-enterprise.agent-api.api.construct-query-response" : {
- "description" : "Response containing a base64-encoded MBQL query for use with /v1/execute.",
- "type" : "object",
- "properties" : {
- "query" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "query" ]
- },
- "metabase-enterprise.agent-api.api.construct-query-table-request" : {
- "description" : "Request schema for constructing a query from a table.\n\n Query components:\n - filters: Filter conditions to apply\n - fields: Specific fields to select (omit for all fields)\n - aggregations: Aggregation functions (sum, count, avg, etc.). Use sort_order on the aggregation to order by it.\n - group_by: Fields to group by, with optional temporal granularity\n - order_by: Order by regular fields only. To order by an aggregation result, use sort_order on the aggregation instead.\n - limit: Maximum rows to return",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "aggregations" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.aggregation"
- }
- }, {
- "type" : "null"
- } ]
- },
- "fields" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"
- }
- }, {
- "type" : "null"
- } ]
- },
- "filters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"
- }
- }, {
- "type" : "null"
- } ]
- },
- "group_by" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.group-by"
- }
- }, {
- "type" : "null"
- } ]
- },
- "limit" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "order_by" : {
- "description" : "Order by regular fields only. To order by aggregation results, use sort_order on the aggregation.",
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.order-by"
- }
- }, {
- "type" : "null"
- } ]
- },
- "table_id" : {
+ "schema_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
- },
- "required" : [ "table_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.agent-api.api.entity-type" : {
- "description" : "The type of queryable entity.",
- "type" : "string",
- "enum" : [ "table", "metric" ]
- },
- "metabase-enterprise.agent-api.api.execute-query-request" : {
- "description" : "Request schema for /v1/execute. Accepts a base64-encoded MBQL query.",
- "type" : "object",
- "properties" : {
- "query" : {
- "type" : "string",
- "minLength" : 1
}
- },
- "required" : [ "query" ]
+ }
},
- "metabase-enterprise.agent-api.api.execute-query-response" : {
- "description" : "Response from query execution. The HTTP status is always 202 because results are streamed —\n check the `status` field to determine success or failure.",
+ "metabase-enterprise.dependencies.api.base-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
- "properties" : {
- "cols" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.column-metadata"
- }
- },
- "rows" : {
- "type" : "array",
- "items" : {
- "type" : "array",
- "items" : { }
- }
- }
- },
- "required" : [ "cols", "rows" ]
- },
- "error" : {
- "type" : "string"
- },
- "row_count" : {
- "type" : "integer"
- },
- "running_time" : {
- "type" : "integer"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "completed", "failed" ]
- }
- },
- "required" : [ "status" ]
- },
- "metabase-enterprise.agent-api.api.field" : {
- "description" : "A field from a table or metric. The field_id format is '<prefix><entity-id>-<field-index>' where prefix indicates the source (t=table, c=metric) and index is the position in the entity's fields.",
- "type" : "object",
- "properties" : {
- "database_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "field_id" : {
- "type" : "string"
+ "properties" : { }
},
- "field_values" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "array",
- "items" : { }
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string"
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
- "semantic_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
},
"type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field-type"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
},
- "required" : [ "field_id", "name" ]
- },
- "metabase-enterprise.agent-api.api.field-type" : {
- "description" : "A data type for a field derived from Metabase's type hierarchy.",
- "type" : "string",
- "enum" : [ "boolean", "date", "datetime", "time", "number", "string" ]
+ "required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.agent-api.api.field-values" : {
- "description" : "Statistics and sample values for a specific field.",
+ "metabase-enterprise.dependencies.api.broken-cards-response" : {
"type" : "object",
"properties" : {
- "field_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "bad_cards" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.card"
+ }
},
- "statistics" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.statistics"
- }, {
- "type" : "null"
- } ]
+ "bad_transforms" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform"
+ }
},
- "values" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : { }
- }, {
- "type" : "null"
- } ]
+ "success" : {
+ "type" : "boolean"
}
- }
+ },
+ "required" : [ "success" ]
},
- "metabase-enterprise.agent-api.api.measure" : {
- "description" : "A reusable aggregation expression associated with a table. Reference via measure_id in the aggregations array.",
+ "metabase-enterprise.dependencies.api.broken-dependent-entity" : {
+ "description" : "Entity returned by /graph/broken endpoint - includes errors but no dependents_count.",
"type" : "object",
"properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "data" : {
+ "type" : "object",
+ "properties" : { }
},
"id" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "name" : {
+ "type" : {
"type" : "string"
}
},
- "required" : [ "id", "name" ]
+ "required" : [ "id", "type", "data" ]
},
- "metabase-enterprise.agent-api.api.metric" : {
- "description" : "A metric with its queryable dimensions and segments. The default_time_dimension_field_id is the field_id of the recommended time dimension for temporal breakouts.",
+ "metabase-enterprise.dependencies.api.card-body" : {
+ "description" : "Schema for an instance of a `:model/Card` (everything is optional to support updates).",
"type" : "object",
"properties" : {
- "default_time_dimension_field_id" : {
+ "dataset_query" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "parameter_mappings" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
"id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "queryable_dimensions" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field"
- }
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}, {
"type" : "null"
} ]
},
- "segments" : {
+ "name" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.segment"
- }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "type" : {
- "const" : "metric"
- },
- "verified" : {
+ "database_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "id", "type", "name" ]
- },
- "metabase-enterprise.agent-api.api.metric-summary" : {
- "description" : "Summary of a metric associated with a table. Includes the field_id of the default time dimension for temporal breakouts.",
- "type" : "object",
- "properties" : {
- "default_time_dimension_field_id" : {
+ },
+ "document_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "result_metadata" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
}, {
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "type" : {
- "const" : "metric"
- }
- },
- "required" : [ "id", "type", "name" ]
- },
- "metabase-enterprise.agent-api.api.related-table" : {
- "description" : "A table related to the queried entity via foreign key. The related_by field indicates the FK field name.",
- "type" : "object",
- "properties" : {
- "database_engine" : {
+ "collection_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "database_id" : {
+ "type" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
}, {
"type" : "null"
} ]
},
- "related_by" : {
+ "parameters" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
}, {
"type" : "null"
} ]
},
- "display_name" : {
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "type" : {
- "const" : "table"
- },
- "fields" : {
+ "dashboard_id" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field"
- }
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
}, {
"type" : "null"
} ]
+ }
+ }
+ },
+ "metabase-enterprise.dependencies.api.card-entity" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "dashboard" : { },
+ "last-edit-info" : { },
+ "view_count" : { },
+ "collection" : { },
+ "document" : { },
+ "creator" : { },
+ "name" : { },
+ "database_id" : { },
+ "document_id" : { },
+ "result_metadata" : { },
+ "query_type" : { },
+ "collection_id" : { },
+ "type" : { },
+ "created_at" : { },
+ "display" : { },
+ "creator_id" : { },
+ "description" : { },
+ "dashboard_id" : { }
+ }
},
- "database_schema" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "const" : "card"
}
},
- "required" : [ "id", "type", "name" ]
+ "required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.agent-api.api.search-response" : {
- "description" : "Search results containing tables and metrics matching the query.",
+ "metabase-enterprise.dependencies.api.dashboard-entity" : {
"type" : "object",
"properties" : {
"data" : {
+ "type" : "object",
+ "properties" : {
+ "last-edit-info" : { },
+ "view_count" : { },
+ "collection" : { },
+ "moderation_reviews" : { },
+ "creator" : { },
+ "name" : { },
+ "collection_id" : { },
+ "created_at" : { },
+ "creator_id" : { },
+ "description" : { }
+ }
+ },
+ "dependents_count" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.search-result-item"
- }
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
- "total_count" : {
- "type" : "integer"
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "type" : {
+ "const" : "dashboard"
}
},
- "required" : [ "data", "total_count" ]
+ "required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.agent-api.api.search-result-item" : {
- "description" : "A table or metric returned from search.",
+ "metabase-enterprise.dependencies.api.document-entity" : {
"type" : "object",
"properties" : {
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "collection" : { },
+ "collection_id" : { },
+ "created_at" : { },
+ "creator" : { },
+ "description" : { },
+ "name" : { },
+ "view_count" : { }
+ }
},
- "verified" : {
+ "dependents_count" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "database_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "updated_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "type" : "string",
- "enum" : [ "table", "metric" ]
- },
- "database_schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "created_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "type", "name" ]
- },
- "metabase-enterprise.agent-api.api.segment" : {
- "description" : "A predefined filter condition that can be applied to queries via the segment_id in filters.",
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name" ]
- },
- "metabase-enterprise.agent-api.api.statistics" : {
- "description" : "Statistical summary of a field's values computed during database sync. Includes counts, percentages, numeric summaries (min/max/avg/quartiles/sd), and date ranges.",
- "type" : "object",
- "properties" : {
- "min" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "percent_url" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "average_length" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "earliest" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "q1" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "max" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "distinct_count" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "percent_state" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "percent_null" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "avg" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "sd" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "percent_email" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "latest" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "q3" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "percent_json" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- }
- }
- },
- "metabase-enterprise.agent-api.api.table" : {
- "description" : "Full details of a table including its fields, related tables, metrics, and segments.",
- "type" : "object",
- "properties" : {
- "database_engine" : {
- "type" : "string"
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "database_id" : {
- "type" : "integer"
- },
- "related_tables" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.related-table"
- }
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
- "type" : "string"
- },
- "segments" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.segment"
- }
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.entity-type"
- },
- "fields" : {
+ "dependents_errors" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field"
- }
- },
- "database_schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "metrics" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.metric-summary"
- }
- }, {
- "type" : "null"
- } ]
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
- "measures" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.measure"
- }
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "type" : {
+ "const" : "document"
}
},
- "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]
+ "required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.data-studio.api.table.publish-tables-response" : {
- "description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",
- "type" : "object",
- "properties" : {
- "target_collection" : {
- "oneOf" : [ {
- "description" : "value must be an instance of :model/Collection"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "target_collection" ]
+ "metabase-enterprise.dependencies.api.entity" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.table-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.snippet-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dashboard-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.document-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.sandbox-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.segment-entity"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.measure-entity"
+ } ]
},
- "metabase-enterprise.data-studio.api.table.table-selectors" : {
+ "metabase-enterprise.dependencies.api.graph-response" : {
"type" : "object",
"properties" : {
- "database_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "schema_ids" : {
+ "edges" : {
"type" : "array",
"items" : {
- "type" : "string"
+ "type" : "object",
+ "properties" : {
+ "from_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
+ },
+ "from_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ },
+ "to_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
+ },
+ "to_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }
+ },
+ "required" : [ "from_entity_type", "from_entity_id", "to_entity_type", "to_entity_id" ]
}
},
- "table_ids" : {
+ "nodes" : {
"type" : "array",
"items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
}
}
- }
+ },
+ "required" : [ "nodes", "edges" ]
},
- "metabase-enterprise.dependencies.api.base-entity" : {
+ "metabase-enterprise.dependencies.api.measure-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
- "properties" : { }
+ "properties" : {
+ "created_at" : { },
+ "creator" : { },
+ "creator_id" : { },
+ "description" : { },
+ "name" : { },
+ "table" : { },
+ "table_id" : { }
+ }
},
"dependents_count" : {
"oneOf" : [ {
@@ -1985,141 +1562,46 @@
"minimum" : 1
},
"type" : {
- "type" : "string"
+ "const" : "measure"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.dependencies.api.broken-cards-response" : {
- "type" : "object",
- "properties" : {
- "bad_cards" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.queries.schema.card"
- }
- },
- "bad_transforms" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms.schema.transform"
- }
- },
- "success" : {
- "type" : "boolean"
- }
- },
- "required" : [ "success" ]
- },
- "metabase-enterprise.dependencies.api.broken-dependent-entity" : {
- "description" : "Entity returned by /graph/broken endpoint - includes errors but no dependents_count.",
+ "metabase-enterprise.dependencies.api.sandbox-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
- "properties" : { }
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
+ "properties" : {
+ "table" : { },
+ "table_id" : { }
+ }
},
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "type", "data" ]
- },
- "metabase-enterprise.dependencies.api.card-body" : {
- "description" : "Schema for an instance of a `:model/Card` (everything is optional to support updates).",
- "type" : "object",
- "properties" : {
- "dataset_query" : {
+ "dependents_count" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
}, {
"type" : "null"
} ]
},
- "parameter_mappings" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
- }, {
- "type" : "null"
- } ]
+ "dependents_errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "uniqueItems" : true
},
"id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "database_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- }, {
- "type" : "null"
- } ]
- },
- "document_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
- }, {
- "type" : "null"
- } ]
- },
- "result_metadata" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
- }, {
- "type" : "null"
- } ]
+ "type" : "integer",
+ "minimum" : 1
},
"type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
- }, {
- "type" : "null"
- } ]
- },
- "parameters" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "dashboard_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
- }, {
- "type" : "null"
- } ]
+ "const" : "sandbox"
}
- }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.dependencies.api.card-entity" : {
+ "metabase-enterprise.dependencies.api.segment-entity" : {
"type" : "object",
"properties" : {
"data" : {
@@ -2164,27 +1646,24 @@
"minimum" : 1
},
"type" : {
- "const" : "card"
+ "const" : "segment"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.dependencies.api.dashboard-entity" : {
+ "metabase-enterprise.dependencies.api.snippet-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
- "last-edit-info" : { },
- "view_count" : { },
"collection" : { },
- "moderation_reviews" : { },
- "creator" : { },
- "name" : { },
"collection_id" : { },
"created_at" : { },
+ "creator" : { },
"creator_id" : { },
- "description" : { }
+ "description" : { },
+ "name" : { }
}
},
"dependents_count" : {
@@ -2206,277 +1685,22 @@
"minimum" : 1
},
"type" : {
- "const" : "dashboard"
+ "const" : "snippet"
}
},
"required" : [ "id", "type", "data", "dependents_count" ]
},
- "metabase-enterprise.dependencies.api.document-entity" : {
+ "metabase-enterprise.dependencies.api.table-entity" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
- "collection" : { },
- "collection_id" : { },
- "created_at" : { },
- "creator" : { },
- "description" : { },
- "name" : { },
- "view_count" : { }
- }
- },
- "dependents_count" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
- }, {
- "type" : "null"
- } ]
- },
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
- "const" : "document"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.entity" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.table-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.snippet-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.dashboard-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.document-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.sandbox-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.segment-entity"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.measure-entity"
- } ]
- },
- "metabase-enterprise.dependencies.api.graph-response" : {
- "type" : "object",
- "properties" : {
- "edges" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "from_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
- },
- "from_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- },
- "to_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.entity-id"
- },
- "to_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- }
- },
- "required" : [ "from_entity_type", "from_entity_id", "to_entity_type", "to_entity_id" ]
- }
- },
- "nodes" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
- }
- }
- },
- "required" : [ "nodes", "edges" ]
- },
- "metabase-enterprise.dependencies.api.measure-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "created_at" : { },
- "creator" : { },
- "creator_id" : { },
- "description" : { },
- "name" : { },
- "table" : { },
- "table_id" : { }
- }
- },
- "dependents_count" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
- }, {
- "type" : "null"
- } ]
- },
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
- "const" : "measure"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.sandbox-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "table" : { },
- "table_id" : { }
- }
- },
- "dependents_count" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
- }, {
- "type" : "null"
- } ]
- },
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
- "const" : "sandbox"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.segment-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "dashboard" : { },
- "last-edit-info" : { },
- "view_count" : { },
- "collection" : { },
- "document" : { },
- "creator" : { },
- "name" : { },
- "database_id" : { },
- "document_id" : { },
- "result_metadata" : { },
- "query_type" : { },
- "collection_id" : { },
- "type" : { },
- "created_at" : { },
- "display" : { },
- "creator_id" : { },
- "description" : { },
- "dashboard_id" : { }
- }
- },
- "dependents_count" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
- }, {
- "type" : "null"
- } ]
- },
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
- "const" : "segment"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.snippet-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "collection" : { },
- "collection_id" : { },
- "created_at" : { },
- "creator" : { },
- "creator_id" : { },
- "description" : { },
- "name" : { }
- }
- },
- "dependents_count" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
- }, {
- "type" : "null"
- } ]
- },
- "dependents_errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
- },
- "uniqueItems" : true
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "type" : {
- "const" : "snippet"
- }
- },
- "required" : [ "id", "type", "data", "dependents_count" ]
- },
- "metabase-enterprise.dependencies.api.table-entity" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : {
- "owner" : { },
- "schema" : { },
- "transform" : { },
- "owner_email" : { },
- "owner_user_id" : { },
+ "owner" : { },
+ "schema" : { },
+ "transform" : { },
+ "owner_email" : { },
+ "owner_user_id" : { },
"name" : { },
"display_name" : { },
"fields" : { },
@@ -2645,146 +1869,85 @@
},
"required" : [ "id", "analyzed_entity_type", "analyzed_entity_id", "error_type" ]
},
- "metabase-enterprise.metabot-v3.client.schema.message" : {
+ "metabase-enterprise.permission-debug.impl.group-id" : {
+ "type" : "integer"
+ },
+ "metabase-enterprise.permission-debug.impl.perm-debug-info" : {
"type" : "object",
"properties" : {
- "content" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "data" : {
+ "type" : "object",
+ "properties" : { }
},
- "role" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.client.schema.role"
+ "decision" : {
+ "type" : "string",
+ "enum" : [ "allow", "denied", "limited" ]
},
- "tool_call_id" : {
- "oneOf" : [ {
+ "message" : {
+ "type" : "array",
+ "items" : {
"type" : "string"
- }, {
- "type" : "null"
- } ]
+ }
},
- "tool_calls" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "arguments" : {
- "type" : "string"
- },
- "id" : {
- "type" : "string"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name", "arguments" ]
- }
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "role" ]
- },
- "metabase-enterprise.metabot-v3.client.schema.messages" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.client.schema.message"
- }
- },
- "metabase-enterprise.metabot-v3.client.schema.role" : {
- "type" : "string",
- "enum" : [ "system", "user", "assistant", "tool" ]
- },
- "metabase-enterprise.metabot-v3.context.context" : {
- "type" : "object",
- "additionalProperties" : { }
- },
- "metabase-enterprise.metabot-v3.tools.api.aggregation" : {
- "description" : "Aggregation — count (field optional), field-based (field required), or measure-based.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.count-aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field-aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.measure-aggregation"
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.answer-sources-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "with_metric_default_temporal_breakout" : {
- "default" : true,
- "type" : "boolean"
- },
- "with_metric_queryable_dimensions" : {
- "default" : true,
- "type" : "boolean"
- },
- "with_model_fields" : {
- "default" : true,
- "type" : "boolean"
+ "model-id" : {
+ "type" : "string"
+ },
+ "model-type" : {
+ "type" : "string",
+ "enum" : [ "card", "invalid" ]
+ },
+ "segment" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "sandboxed", "impersonated", "routed" ]
},
- "with_model_metrics" : {
- "default" : true,
- "type" : "boolean"
+ "uniqueItems" : true
+ },
+ "suggestions" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
}
}
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ },
+ "required" : [ "model-type", "model-id", "decision", "segment", "message", "data", "suggestions" ]
},
- "metabase-enterprise.metabot-v3.tools.api.answer-sources-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "metrics" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.full-metric"
- }
- },
- "models" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.table-result"
- }
- }
- },
- "required" : [ "metrics", "models" ]
+ "metabase-enterprise.replacement.schema.check-replace-source-response" : {
+ "type" : "object",
+ "properties" : {
+ "column_mappings" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column-mapping"
}
},
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
+ "errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.error-type"
}
},
- "required" : [ "output" ]
- } ]
+ "success" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "success" ]
},
- "metabase-enterprise.metabot-v3.tools.api.basic-metric" : {
+ "metabase-enterprise.replacement.schema.column" : {
"type" : "object",
"properties" : {
- "default_time_dimension_field_id" : {
+ "base_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "display_name" : {
+ "type" : "string"
+ },
+ "effective_type" : {
"oneOf" : [ {
"type" : "string"
}, {
@@ -2792,714 +1955,649 @@
} ]
},
"id" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
},
"name" : {
"type" : "string"
},
- "type" : {
- "const" : "metric"
+ "semantic_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "id", "type", "name" ]
+ "required" : [ "id", "name", "display_name", "base_type", "effective_type", "semantic_type" ]
},
- "metabase-enterprise.metabot-v3.tools.api.basic-snippet" : {
+ "metabase-enterprise.replacement.schema.column-mapping" : {
"type" : "object",
"properties" : {
- "description" : {
+ "errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.source-swap.schema.column-error"
+ }
+ },
+ "source" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column"
}, {
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
+ "target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "required" : [ "id", "name" ]
+ }
+ },
+ "metabase-enterprise.replacement.schema.error-type" : {
+ "type" : "string",
+ "enum" : [ "cycle-detected", "database-mismatch", "incompatible-implicit-joins" ]
},
- "metabase-enterprise.metabot-v3.tools.api.basic-transform" : {
+ "metabase-enterprise.replacement.schema.run" : {
"type" : "object",
"properties" : {
- "description" : {
+ "message" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "entity_id" : {
+ "target_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "user_id" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "progress" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
"id" : {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
},
- "name" : {
- "type" : "string"
+ "source_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
},
- "source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.transforms.transform-source"
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-status"
},
- "type" : {
+ "source_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "end_time" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "start_time" : {
"type" : "string",
- "enum" : [ "mbql", "native", "python" ]
+ "format" : "date-time"
}
},
- "required" : [ "id", "name", "type", "source" ]
+ "required" : [ "id", "status", "is_active", "source_entity_type", "source_entity_id", "target_entity_type", "target_entity_id", "progress", "message", "user_id", "start_time", "end_time" ]
},
- "metabase-enterprise.metabot-v3.tools.api.broken-question" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name" ]
+ "metabase-enterprise.replacement.schema.run-id" : {
+ "type" : "integer",
+ "minimum" : 1
},
- "metabase-enterprise.metabot-v3.tools.api.broken-transform" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name" ]
+ "metabase-enterprise.replacement.schema.run-status" : {
+ "type" : "string",
+ "enum" : [ "pending", "started", "succeeded", "failed", "canceled", "timeout" ]
+ },
+ "metabase-enterprise.replacement.schema.source-entity-id" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ } ]
},
- "metabase-enterprise.metabot-v3.tools.api.bucket" : {
+ "metabase-enterprise.replacement.schema.source-entity-type" : {
"type" : "string",
- "enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year", "second-of-minute", "minute-of-hour", "hour-of-day", "day-of-week", "day-of-month", "day-of-year", "week-of-year", "month-of-year", "quarter-of-year", "year-of-era" ]
+ "enum" : [ "card", "table", "transform" ]
},
- "metabase-enterprise.metabot-v3.tools.api.check-transform-dependencies-arguments" : {
- "allOf" : [ {
+ "metabase-enterprise.sandbox.schema.attribute-remappings" : {
+ "description" : "value must be a valid attribute remappings map (attribute name -> remapped name)",
+ "oneOf" : [ {
"type" : "object",
- "properties" : {
- "source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.transforms.transform-source"
- },
- "transform_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "transform_id", "source" ]
+ "additionalProperties" : {
+ "anyOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ } ]
+ }
}, {
- "type" : "object",
- "properties" : { }
+ "type" : "null"
} ]
},
- "metabase-enterprise.metabot-v3.tools.api.check-transform-dependencies-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "bad_question_count" : {
- "type" : "integer"
- },
- "bad_questions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.broken-question"
- }
- },
- "bad_transform_count" : {
- "type" : "integer"
- },
- "bad_transforms" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.broken-transform"
- }
- },
- "success" : {
- "type" : "boolean"
- }
- },
- "required" : [ "success", "bad_transform_count", "bad_transforms", "bad_question_count", "bad_questions" ]
- }
+ "metabase-enterprise.support-access-grants.schema.create-grant-request" : {
+ "description" : "Schema for POST /api/ee/support-access-grants request body.",
+ "type" : "object",
+ "properties" : {
+ "grant_duration_minutes" : {
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 10080
},
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
+ "notes" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 255
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "output" ]
+ "ticket_number" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 100
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "grant_duration_minutes" ]
+ },
+ "metabase-enterprise.support-access-grants.schema.current-grant-response" : {
+ "description" : "Schema for GET /api/ee/support-access-grants/current response.",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
+ }, {
+ "type" : "null"
} ]
},
- "metabase-enterprise.metabot-v3.tools.api.column" : {
+ "metabase-enterprise.support-access-grants.schema.grant-response" : {
+ "description" : "Schema for a support access grant object in API responses.",
"type" : "object",
"properties" : {
- "database_type" : {
+ "user_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "token" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "user_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "field_id" : {
- "type" : "string"
+ "user_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "field_values" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field-values"
+ "grant_end_timestamp" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
},
- "name" : {
- "type" : "string"
+ "revoked_at" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ }, {
+ "type" : "null"
+ } ]
},
- "semantic_type" : {
+ "revoked_by_user_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "ticket_number" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "type" : {
+ "updated_at" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ },
+ "created_at" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ },
+ "notes" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field-type"
+ "type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "grant_start_timestamp" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
}
},
- "required" : [ "field_id", "name", "type" ]
- },
- "metabase-enterprise.metabot-v3.tools.api.columns" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.column"
- }
- },
- "metabase-enterprise.metabot-v3.tools.api.count" : {
- "type" : "integer"
+ "required" : [ "id", "user_id", "user_name", "user_email", "ticket_number", "notes", "grant_start_timestamp", "grant_end_timestamp", "revoked_at", "revoked_by_user_id", "created_at", "updated_at" ]
},
- "metabase-enterprise.metabot-v3.tools.api.count-aggregation" : {
- "description" : "Count aggregation — counts rows, no field_id needed.\n Use sort_order to order results by this aggregation ('asc' or 'desc').",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.bucket"
- },
- "function" : {
- "const" : "count"
- },
- "sort_order" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "asc", "desc" ]
- }, {
- "type" : "null"
- } ]
+ "metabase-enterprise.support-access-grants.schema.list-grants-response" : {
+ "description" : "Schema for GET /api/ee/support-access-grants response (paginated list).",
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
}
},
- "required" : [ "function" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.create-alert-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "card_id" : {
- "type" : "integer"
- },
- "schedule" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.subscription-schedule"
- },
- "send_condition" : {
- "type" : "string",
- "enum" : [ "has_result", "goal_above", "goal_below" ]
- },
- "send_once" : {
- "default" : false,
- "type" : "boolean"
- },
- "slack_channel" : {
- "type" : "string"
- }
+ "limit" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "required" : [ "card_id", "send_condition", "schedule", "slack_channel" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.create-dashboard-subscription-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "dashboard_id" : {
- "type" : "integer"
- },
- "schedule" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.subscription-schedule"
- },
- "slack_channel" : {
- "type" : "string"
- }
+ "offset" : {
+ "type" : "integer",
+ "minimum" : 0
},
- "required" : [ "dashboard_id", "slack_channel", "schedule" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "total" : {
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "data", "total", "limit", "offset" ]
},
- "metabase-enterprise.metabot-v3.tools.api.disjunctive-numeric-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals" ]
- },
- "values" : {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "number"
- } ]
- }
- }
- },
- "required" : [ "field_id", "operation", "values" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "metabase-enterprise.support-access-grants.schema.timestamp" : {
+ "anyOf" : [ { }, { } ]
},
- "metabase-enterprise.metabot-v3.tools.api.disjunctive-string-date-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals", "string-contains", "string-not-contains", "string-starts-with", "string-ends-with" ]
- },
- "values" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
+ "metabase-enterprise.transforms-inspector.schema.alert-trigger" : {
+ "description" : "Definition for conditional alerts.\n FE evaluates condition against card results and shows alert if triggered.",
+ "type" : "object",
+ "properties" : {
+ "condition" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-condition"
},
- "required" : [ "field_id", "operation", "values" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.disjunctive-temporal-extraction-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "year-equals", "year-not-equals", "quarter-equals", "quarter-not-equals", "month-equals", "month-not-equals", "day-of-week-equals", "day-of-week-not-equals", "hour-equals", "hour-not-equals", "minute-equals", "minute-not-equals", "second-equals", "second-not-equals" ]
- },
- "values" : {
- "type" : "array",
- "items" : {
- "type" : "integer"
- }
- }
+ "id" : {
+ "type" : "string"
},
- "required" : [ "field_id", "operation", "values" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.disjunctive-temporal-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.bucket"
- },
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ]
- },
- "values" : {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "integer"
- } ]
- }
- }
+ "message" : {
+ "type" : "string"
},
- "required" : [ "field_id", "operation", "values" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.existence-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "is-null", "is-not-null", "string-is-empty", "string-is-not-empty", "is-true", "is-false" ]
- }
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
},
- "required" : [ "field_id", "operation" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "severity" : {
+ "type" : "string",
+ "enum" : [ "info", "warning", "error" ]
+ }
+ },
+ "required" : [ "id", "condition", "severity", "message" ]
},
- "metabase-enterprise.metabot-v3.tools.api.field" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.bucket"
- },
- "field_id" : {
+ "metabase-enterprise.transforms-inspector.schema.card" : {
+ "description" : "A visualization card in the inspector output.\n\n Cards are generic - lens-specific data goes in :metadata.\n The :metadata map is opaque to the core but interpreted by\n lens-specific lib utilities on the frontend. ",
+ "type" : "object",
+ "properties" : {
+ "dataset_query" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.query"
+ },
+ "display" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.display-type"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.card-metadata"
+ },
+ "section_id" : {
+ "oneOf" : [ {
"type" : "string"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "field_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "title" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "title", "display", "dataset_query" ]
},
- "metabase-enterprise.metabot-v3.tools.api.field-aggregation" : {
- "description" : "Aggregation using a field and function. field_id is required.\n Use sort_order to order results by this aggregation ('asc' or 'desc').",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.bucket"
- },
- "field_id" : {
+ "metabase-enterprise.transforms-inspector.schema.card-metadata" : {
+ "description" : "Common metadata for join-related cards and triggers.",
+ "type" : "object",
+ "properties" : {
+ "dedup_key" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.dedup-key"
+ },
+ "group_id" : {
+ "type" : "string"
+ },
+ "group_order" : {
+ "type" : "integer"
+ },
+ "card_type" : {
+ "type" : "string"
+ },
+ "group_role" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.group-role"
+ },
+ "join_step" : {
+ "type" : "integer"
+ },
+ "join_alias" : {
+ "type" : "string"
+ },
+ "join_strategy" : {
+ "type" : "string"
+ },
+ "depends_on_cards" : {
+ "type" : "array",
+ "items" : {
"type" : "string"
},
- "function" : {
- "type" : "string",
- "enum" : [ "avg", "count-distinct", "max", "min", "sum" ]
- },
- "sort_order" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "asc", "desc" ]
- }, {
- "type" : "null"
- } ]
- }
+ "uniqueItems" : true
+ }
+ }
+ },
+ "metabase-enterprise.transforms-inspector.schema.complexity" : {
+ "description" : "Complexity estimate for a lens.",
+ "type" : "object",
+ "properties" : {
+ "level" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity-level"
},
- "required" : [ "field_id", "function" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "score" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "level" ]
},
- "metabase-enterprise.metabot-v3.tools.api.field-type" : {
+ "metabase-enterprise.transforms-inspector.schema.complexity-level" : {
+ "description" : "Estimated complexity/cost of generating a lens.",
"type" : "string",
- "enum" : [ "boolean", "date", "datetime", "time", "number", "string" ]
+ "enum" : [ "fast", "slow", "very-slow" ]
},
- "metabase-enterprise.metabot-v3.tools.api.field-values" : {
- "anyOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "boolean"
- }
- }, {
- "type" : "array",
- "items" : {
- "type" : "number"
- }
- }, {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.field-values-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "entity_id" : {
- "type" : "integer"
- },
- "entity_type" : {
- "type" : "string",
- "enum" : [ "table", "model", "metric" ]
- },
- "field_id" : {
- "type" : "string"
- },
- "limit" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "entity_type", "entity_id", "field_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "metabase-enterprise.transforms-inspector.schema.dedup-key" : {
+ "description" : "Key for deduplicating identical queries across lenses.\n Typically a vector like [:table_count table-id].",
+ "type" : "array",
+ "items" : { }
},
- "metabase-enterprise.metabot-v3.tools.api.field-values-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "value_metadata" : {
- "type" : "object",
- "properties" : {
- "field_values" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : { }
- }, {
- "type" : "null"
- } ]
- },
- "statistics" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.statistics"
- }, {
- "type" : "null"
- } ]
- }
- }
- }
- },
- "required" : [ "field_id", "value_metadata" ]
+ "metabase-enterprise.transforms-inspector.schema.discovery-response" : {
+ "description" : "Response from lens discovery.",
+ "type" : "object",
+ "properties" : {
+ "available_lenses" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-metadata"
}
},
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
+ "description" : {
+ "oneOf" : [ {
"type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "sources" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
}
},
- "required" : [ "output" ]
- } ]
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.inspector-status"
+ },
+ "target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visited_fields" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.visited-fields"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name", "status", "sources", "available_lenses" ]
},
- "metabase-enterprise.metabot-v3.tools.api.filter" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.segment-filter"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.existence-filter"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.temporal-extraction-filter"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.disjunctive-temporal-extraction-filter"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.temporal-filter"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.disjunctive-temporal-filter"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.string-filter"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.disjunctive-string-date-filter"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.numeric-filter"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.disjunctive-numeric-filter"
- } ]
+ "metabase-enterprise.transforms-inspector.schema.display-type" : {
+ "description" : "Valid display types for cards.",
+ "type" : "string",
+ "enum" : [ "bar", "row", "line", "area", "pie", "scalar", "gauge", "progress", "table", "hidden" ]
},
- "metabase-enterprise.metabot-v3.tools.api.filter-records-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "data_source" : {
- "allOf" : [ {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "query" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "type" : "integer"
- }
- },
- "required" : [ "database" ]
- },
- "query_id" : {
- "type" : "string"
- }
- },
- "required" : [ "query" ]
- }, {
- "type" : "object",
- "properties" : {
- "report_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "report_id" ]
- }, {
- "type" : "object",
- "properties" : {
- "table_id" : {
- "type" : "string"
- }
- },
- "required" : [ "table_id" ]
- } ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "filters" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"
- }
- }
+ "metabase-enterprise.transforms-inspector.schema.drill-lens" : {
+ "description" : "A drill-down lens available from the current lens.",
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "data_source", "filters" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ]
},
- "metabase-enterprise.metabot-v3.tools.api.filtering-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "query" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Query"
- },
- "query_id" : {
- "type" : "string"
- },
- "result_columns" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.column"
- }
- },
- "type" : {
- "const" : "query"
- }
- },
- "required" : [ "type", "query_id", "query", "result_columns" ]
- }
+ "metabase-enterprise.transforms-inspector.schema.drill-lens-trigger" : {
+ "description" : "Definition for conditional drill lens availability.\n FE evaluates condition and shows drill lens option if triggered.\n :params is passed to the drill lens when triggered.",
+ "type" : "object",
+ "properties" : {
+ "condition" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-condition"
},
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
+ "lens_id" : {
+ "type" : "string"
},
- "required" : [ "output" ]
- } ]
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
+ },
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : { }
+ },
+ "reason" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "lens_id", "condition" ]
},
- "metabase-enterprise.metabot-v3.tools.api.full-metric" : {
+ "metabase-enterprise.transforms-inspector.schema.field" : {
+ "description" : "Field metadata for inspector.",
"type" : "object",
"properties" : {
- "default_time_dimension_field_id" : {
+ "base_type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "display_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
- "id" : {
+ "stats" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.field-stats"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "base_type" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.field-stats" : {
+ "description" : "Statistics for a field from fingerprints.",
+ "type" : "object",
+ "properties" : {
+ "min" : {
+ "type" : "number"
+ },
+ "earliest" : {
+ "type" : "string"
+ },
+ "q1" : {
+ "type" : "number"
+ },
+ "max" : {
+ "type" : "number"
+ },
+ "distinct_count" : {
"type" : "integer"
},
- "name" : {
+ "nil_percent" : {
+ "type" : "number"
+ },
+ "avg" : {
+ "type" : "number"
+ },
+ "latest" : {
"type" : "string"
},
- "queryable_dimensions" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.columns"
+ "q3" : {
+ "type" : "number"
+ }
+ }
+ },
+ "metabase-enterprise.transforms-inspector.schema.group-role" : {
+ "description" : "Role of a card within a comparison group.",
+ "type" : "string",
+ "enum" : [ "input", "output" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.inspector-status" : {
+ "description" : "Status of the inspector result.",
+ "type" : "string",
+ "enum" : [ "not-run", "ready" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.layout-type" : {
+ "description" : "Layout hints for sections.\n - :flat - cards displayed in a grid\n - :comparison - cards grouped for side-by-side comparison",
+ "type" : "string",
+ "enum" : [ "flat", "comparison" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.lens" : {
+ "description" : "Full lens contents and drill lens/alert triggers.",
+ "type" : "object",
+ "properties" : {
+ "complexity" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity"
},
- "segments" : {
+ "sections" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.segment"
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.section"
}
},
- "type" : {
- "const" : "metric"
+ "id" : {
+ "type" : "string"
},
- "verified" : {
- "type" : "boolean"
+ "summary" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-summary"
+ },
+ "alert_triggers" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.alert-trigger"
+ }
+ },
+ "drill_lenses" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.drill-lens"
+ }
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "drill_lens_triggers" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.drill-lens-trigger"
+ }
+ },
+ "cards" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.card"
+ }
}
},
- "required" : [ "id", "type", "name" ]
+ "required" : [ "id", "display_name", "sections", "cards" ]
},
- "metabase-enterprise.metabot-v3.tools.api.full-snippet" : {
+ "metabase-enterprise.transforms-inspector.schema.lens-metadata" : {
"type" : "object",
"properties" : {
- "content" : {
- "type" : "string"
+ "complexity" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity"
},
"description" : {
"oneOf" : [ {
@@ -3508,19 +2606,46 @@
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer"
+ "display_name" : {
+ "type" : "string"
},
- "name" : {
+ "id" : {
"type" : "string"
}
},
- "required" : [ "id", "name", "content" ]
+ "required" : [ "id", "display_name" ]
},
- "metabase-enterprise.metabot-v3.tools.api.full-transform" : {
+ "metabase-enterprise.transforms-inspector.schema.lens-summary" : {
+ "description" : "Summary section of a lens.",
"type" : "object",
"properties" : {
- "entity_id" : {
+ "alerts" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "highlights" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.summary-highlight"
+ }
+ },
+ "text" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ },
+ "metabase-enterprise.transforms-inspector.schema.section" : {
+ "description" : "A section grouping cards in a lens.",
+ "type" : "object",
+ "properties" : {
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
@@ -3528,1205 +2653,982 @@
} ]
},
"id" : {
- "type" : "integer"
- },
- "name" : {
"type" : "string"
},
- "updated_at" : {
- "description" : "value must be a valid date string",
+ "layout" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.layout-type"
+ },
+ "title" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "title" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.summary-highlight" : {
+ "description" : "A highlight in the lens summary.",
+ "type" : "object",
+ "properties" : {
+ "card_id" : {
"type" : "string"
},
- "source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.transforms.transform-source"
+ "label" : {
+ "type" : "string"
},
- "type" : {
- "type" : "string",
- "enum" : [ "mbql", "native", "python" ]
+ "value" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "label" ]
+ },
+ "metabase-enterprise.transforms-inspector.schema.table" : {
+ "description" : "Table metadata.",
+ "type" : "object",
+ "properties" : {
+ "column_count" : {
+ "type" : "integer"
},
- "target" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.transforms.transform-target"
+ "db_id" : {
+ "type" : "integer",
+ "minimum" : 1
},
- "created_at" : {
- "description" : "value must be a valid date string",
- "type" : "string"
+ "fields" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.field"
+ }
},
- "description" : {
+ "schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "table_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "table_name" : {
+ "type" : "string"
}
},
- "required" : [ "id", "name", "type", "source", "created_at", "updated_at", "target" ]
+ "required" : [ "table_id", "table_name", "db_id", "column_count", "fields" ]
},
- "metabase-enterprise.metabot-v3.tools.api.generate-insights-arguments" : {
+ "metabase-enterprise.transforms-inspector.schema.trigger-condition" : {
+ "description" : "A named condition that triggers an alert or drill lens.\n Evaluated by multimethod in lib against card results.\n Only :name is required; other keys are condition-specific.",
"type" : "object",
"properties" : {
- "for" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "metric_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "metric_id" ]
- }, {
- "type" : "object",
- "properties" : {
- "table_id" : {
- "type" : "string"
- }
- },
- "required" : [ "table_id" ]
- }, {
- "type" : "object",
- "properties" : {
- "report_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "report_id" ]
- }, {
- "type" : "object",
- "properties" : {
- "query" : {
- "type" : "object",
- "properties" : { }
- }
- },
- "required" : [ "query" ]
- } ]
+ "name" : {
+ "type" : "string"
}
},
- "required" : [ "for" ]
+ "required" : [ "name" ]
},
- "metabase-enterprise.metabot-v3.tools.api.get-current-user-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "email_address" : {
- "type" : "string"
- },
- "glossary" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "type" : {
- "const" : "user"
- }
- },
- "required" : [ "id", "type", "name", "email_address", "glossary" ]
- }
+ "metabase-enterprise.transforms-inspector.schema.trigger-metadata" : {
+ "description" : "Common metadata for join-related cards and triggers.",
+ "type" : "object",
+ "properties" : {
+ "join_alias" : {
+ "type" : "string"
},
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
+ "join_step" : {
+ "type" : "integer"
},
- "required" : [ "output" ]
- } ]
+ "join_strategy" : {
+ "type" : "string"
+ }
+ }
},
- "metabase-enterprise.metabot-v3.tools.api.get-dashboard-details-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "dashboard_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "dashboard_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "metabase-enterprise.transforms-inspector.schema.visited-fields" : {
+ "description" : "Field IDs used in semantically important query clauses.\n Used for interestingness scoring and preselection.",
+ "type" : "object",
+ "properties" : {
+ "all" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "uniqueItems" : true
+ }
+ }
},
- "metabase-enterprise.metabot-v3.tools.api.get-dashboard-details-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "type" : "string"
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "type" : {
- "const" : "dashboard"
- },
- "verified" : {
- "type" : "boolean"
- }
- },
- "required" : [ "id", "type", "name" ]
+ "metabase-enterprise.workspaces.types.ancestors-result" : {
+ "description" : "Result of running stale ancestor transforms.",
+ "type" : "object",
+ "properties" : {
+ "failed" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
}
},
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
+ "not_run" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
}
},
- "required" : [ "output" ]
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-document-details-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "document_id" : {
- "type" : "integer"
+ "succeeded" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
}
- },
- "required" : [ "document_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ }
+ },
+ "required" : [ "succeeded", "failed", "not_run" ]
},
- "metabase-enterprise.metabot-v3.tools.api.get-document-details-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "document" : {
- "type" : "string"
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name", "document" ]
- }
+ "metabase-enterprise.workspaces.types.appdb-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase-enterprise.workspaces.types.execution-result" : {
+ "type" : "object",
+ "properties" : {
+ "ancestors" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ancestors-result"
},
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "oneOf" : [ {
"type" : "string"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "output" ]
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-metric-details-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "metric_id" : {
- "type" : "integer"
- },
- "with_default_temporal_breakout" : {
- "default" : true,
- "type" : "boolean"
- },
- "with_field_values" : {
- "default" : true,
- "type" : "boolean"
- },
- "with_queryable_dimensions" : {
- "default" : true,
- "type" : "boolean"
- },
- "with_segments" : {
- "default" : false,
- "type" : "boolean"
- }
+ "start_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "metric_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "status" : {
+ "type" : "string",
+ "enum" : [ "succeeded", "failed" ]
+ },
+ "table" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name" ]
+ }
+ },
+ "required" : [ "status", "table" ]
},
- "metabase-enterprise.metabot-v3.tools.api.get-metric-details-result" : {
+ "metabase-enterprise.workspaces.types.flag" : {
+ "description" : "Boolean flag that accepts true, false, or 1 (for query param compatibility).",
"anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.full-metric"
- }
- },
- "required" : [ "structured_output" ]
+ "const" : 1
}, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
- },
- "required" : [ "output" ]
+ "type" : "boolean"
} ]
},
- "metabase-enterprise.metabot-v3.tools.api.get-query-details-arguments" : {
+ "metabase-enterprise.workspaces.types.problem" : {
+ "description" : "A problem detected during workspace validation.",
"type" : "object",
"properties" : {
- "query" : {
+ "block_merge" : {
+ "type" : "boolean"
+ },
+ "category" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.problem-category"
+ },
+ "data" : {
"type" : "object",
"properties" : { }
+ },
+ "problem" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.problem-name"
+ },
+ "severity" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.severity"
}
},
- "required" : [ "query" ]
+ "required" : [ "category", "problem", "severity", "block_merge", "data" ]
},
- "metabase-enterprise.metabot-v3.tools.api.get-query-details-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "query" : {
+ "metabase-enterprise.workspaces.types.problem-category" : {
+ "type" : "string",
+ "enum" : [ "external", "external-downstream", "unused", "internal", "internal-downstream" ]
+ },
+ "metabase-enterprise.workspaces.types.problem-name" : {
+ "type" : "string",
+ "enum" : [ "target-conflict", "not-run", "stale", "cycle", "failed", "removed-table", "removed-field" ]
+ },
+ "metabase-enterprise.workspaces.types.query-result" : {
+ "description" : "Result of a query preview (dry-run or ad-hoc query).\n Data is nested under :data to match /api/dataset response format.",
+ "type" : "object",
+ "properties" : {
+ "ancestors" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ancestors-result"
+ },
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "cols" : {
+ "type" : "array",
+ "items" : {
"type" : "object",
"properties" : { }
- },
- "query_id" : {
- "type" : "string"
- },
- "result_columns" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.columns"
- },
- "type" : {
- "const" : "query"
}
},
- "required" : [ "type", "query_id", "query", "result_columns" ]
- }
- },
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
- },
- "required" : [ "output" ]
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-report-details-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "report_id" : {
- "type" : "integer"
- },
- "with_field_values" : {
- "default" : true,
- "type" : "boolean"
- },
- "with_fields" : {
- "default" : true,
- "type" : "boolean"
- }
- },
- "required" : [ "report_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-report-details-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "result_columns" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.columns"
- },
- "type" : {
- "const" : "question"
- },
- "verified" : {
- "type" : "boolean"
+ "results_metadata" : {
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }
}
},
- "required" : [ "id", "type", "name", "result_columns" ]
+ "rows" : {
+ "type" : "array",
+ "items" : { }
+ }
}
},
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
+ "message" : {
+ "oneOf" : [ {
"type" : "string"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "output" ]
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-snippet-details-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "snippet_id" : {
+ "running_time" : {
+ "oneOf" : [ {
"type" : "integer"
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "snippet_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-snippet-details-result" : {
- "description" : "Schema for SQL snippet detail results",
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.full-snippet"
+ "started_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "succeeded", "failed" ]
}
},
- "required" : [ "structured_output" ]
+ "required" : [ "status" ]
},
- "metabase-enterprise.metabot-v3.tools.api.get-snippets-result" : {
- "description" : "Schema for SQL snippet list results",
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.basic-snippet"
- }
- }
- },
- "required" : [ "structured_output" ]
+ "metabase-enterprise.workspaces.types.ref-id" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "metabase-enterprise.workspaces.types.severity" : {
+ "type" : "string",
+ "enum" : [ "error", "warning", "info" ]
},
- "metabase-enterprise.metabot-v3.tools.api.get-table-details-arguments" : {
+ "metabase.actions.schema..action.for-insert" : {
+ "description" : "Schema for inserting a new Action (REST API or internally).",
"allOf" : [ {
"type" : "object",
"properties" : {
- "with_metric_default_temporal_breakout" : {
- "default" : true,
- "type" : "boolean"
- },
- "with_fields" : {
- "default" : true,
+ "archived" : {
"type" : "boolean"
},
- "with_field_values" : {
- "default" : true,
- "type" : "boolean"
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "with_related_tables" : {
- "default" : true,
- "type" : "boolean"
+ "model_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
- "with_segments" : {
- "default" : false,
- "type" : "boolean"
+ "name" : {
+ "type" : "string"
},
- "with_metrics" : {
- "default" : true,
- "type" : "boolean"
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
},
- "table_id" : {
- "anyOf" : [ {
- "type" : "integer"
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
}, {
- "type" : "string"
+ "type" : "null"
} ]
},
- "with_measures" : {
- "default" : false,
- "type" : "boolean"
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.type"
},
- "model_id" : {
- "type" : "integer"
- }
- }
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-table-details-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.table-result"
- }
- },
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
- },
- "required" : [ "output" ]
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-tables-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "database_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-tables-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "type" : "string"
- },
- "engine" : {
- "type" : "string"
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "engine", "name", "description" ]
- },
- "tables" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "columns" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "type" : "string"
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name", "description", "type" ]
- }
- },
- "description" : {
- "type" : "string"
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name", "description", "columns" ]
- }
- }
- },
- "required" : [ "database", "tables" ]
- }
- },
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
- },
- "required" : [ "output" ]
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-transform-details-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "transform_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "transform_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-transform-details-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.full-transform"
- }
- }
- },
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
- },
- "required" : [ "output" ]
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-transform-python-library-details-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "path" : {
- "type" : "string"
- }
- },
- "required" : [ "path" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-transform-python-library-details-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "created_at" : {
- "description" : "value must be a valid date string",
- "type" : "string"
- },
- "path" : {
- "type" : "string"
- },
- "source" : {
- "type" : "string"
- },
- "updated_at" : {
- "description" : "value must be a valid date string",
- "type" : "string"
- }
- },
- "required" : [ "source", "path", "created_at", "updated_at" ]
- }
- },
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
- },
- "required" : [ "output" ]
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.get-transforms-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.basic-transform"
- }
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "structured_output" ]
+ "required" : [ "name", "type", "model_id" ]
}, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
- },
- "required" : [ "output" ]
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema.http-action"
+ }, {
+ "$ref" : "#/components/schemas/metabase.actions.schema.implicit-action"
+ }, {
+ "$ref" : "#/components/schemas/metabase.actions.schema.query-action"
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
} ]
},
- "metabase-enterprise.metabot-v3.tools.api.group-by" : {
+ "metabase.actions.schema..action.for-update" : {
+ "description" : "Schema for updating an Action (REST API or internally).",
"allOf" : [ {
"type" : "object",
"properties" : {
- "field_granularity" : {
+ "visualization_settings" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "minute", "hour", "day", "week", "month", "quarter", "year", "day-of-week" ]
+ "type" : "object"
}, {
"type" : "null"
} ]
},
- "field_id" : {
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ },
+ "name" : {
"type" : "string"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.type"
+ },
+ "model_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "required" : [ "field_id" ]
+ }
}, {
- "type" : "object",
- "properties" : { }
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema.http-action"
+ }, {
+ "$ref" : "#/components/schemas/metabase.actions.schema.implicit-action"
+ }, {
+ "$ref" : "#/components/schemas/metabase.actions.schema.query-action"
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
} ]
},
- "metabase-enterprise.metabot-v3.tools.api.measure" : {
+ "metabase.actions.schema..http-action.json-query" : {
+ "description" : "must be a valid json-query, something like '.item.title'",
+ "type" : "string"
+ },
+ "metabase.actions.schema..http-action.template" : {
"type" : "object",
"properties" : {
- "definition" : {
+ "body" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : { }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "headers" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "display_name" : {
+ "method" : {
+ "type" : "string",
+ "enum" : [ "GET", "POST", "PUT", "DELETE", "PATCH" ]
+ },
+ "parameters" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
}, {
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer"
- },
- "name" : {
+ "url" : {
"type" : "string"
}
},
- "required" : [ "id", "name" ]
- },
- "metabase-enterprise.metabot-v3.tools.api.measure-aggregation" : {
- "description" : "Aggregation using a pre-defined measure.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "measure_id" : {
- "type" : "integer"
- },
- "sort_order" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "asc", "desc" ]
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "measure_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.numeric-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ]
- },
- "value" : {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "number"
- } ]
- }
- },
- "required" : [ "field_id", "operation", "value" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.order-by" : {
- "description" : "Order by item specifying a field and sort direction.",
- "type" : "object",
- "properties" : {
- "direction" : {
- "type" : "string",
- "enum" : [ "asc", "desc" ]
- },
- "field" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"
- }
- },
- "required" : [ "field", "direction" ]
+ "required" : [ "method", "url" ],
+ "additionalProperties" : false
},
- "metabase-enterprise.metabot-v3.tools.api.proportion" : {
- "type" : "number"
+ "metabase.actions.schema..implicit-action.kind" : {
+ "description" : "Unsupported implicit action kind",
+ "type" : "string",
+ "enum" : [ "row/create", "row/update", "row/delete", "bulk/create", "bulk/update", "bulk/delete" ]
},
- "metabase-enterprise.metabot-v3.tools.api.query-datasource-arguments" : {
+ "metabase.actions.schema.action" : {
+ "description" : "An Action as it should appear when we `SELECT` it from the app DB.",
"allOf" : [ {
"type" : "object",
"properties" : {
- "aggregations" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.aggregation"
- }
- }, {
- "type" : "null"
- } ]
- },
- "fields" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"
- }
- }, {
- "type" : "null"
- } ]
- },
- "filters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"
- }
- }, {
- "type" : "null"
- } ]
- },
- "group_by" : {
+ "visualization_settings" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.group-by"
- }
+ "type" : "object"
}, {
"type" : "null"
} ]
},
- "limit" : {
+ "parameter_mappings" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
}, {
"type" : "null"
} ]
},
- "model_id" : {
- "type" : "integer"
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
},
- "order_by" : {
+ "made_public_by_id" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.order-by"
- }
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
- "table_id" : {
- "type" : "integer"
- }
- }
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.query-metric-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "filters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"
- }
- }, {
- "type" : "null"
- } ]
+ "name" : {
+ "type" : "string"
},
- "group_by" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.group-by"
- }
- }, {
- "type" : "null"
- } ]
+ "archived" : {
+ "type" : "boolean"
},
- "metric_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "metric_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.query-model-arguments" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "aggregations" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.aggregation"
- }
- }, {
- "type" : "null"
- } ]
+ "updated_at" : { },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.type"
},
- "fields" : {
+ "created_at" : { },
+ "public_uuid" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"
- }
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
}, {
"type" : "null"
} ]
},
- "filters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"
- }
- }, {
- "type" : "null"
- } ]
+ "model_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
- "group_by" : {
+ "parameters" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.group-by"
- }
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
}, {
"type" : "null"
} ]
},
- "limit" : {
+ "creator_id" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
}, {
"type" : "null"
} ]
},
- "model_id" : {
- "type" : "integer"
- },
- "order_by" : {
+ "description" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.order-by"
- }
+ "type" : "string"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "model_id" ]
+ "required" : [ "id" ]
}, {
- "type" : "object",
- "properties" : { }
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema.http-action"
+ }, {
+ "$ref" : "#/components/schemas/metabase.actions.schema.implicit-action"
+ }, {
+ "$ref" : "#/components/schemas/metabase.actions.schema.query-action"
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ } ]
+ },
+ "metabase.actions.schema.http-action" : {
+ "type" : "object",
+ "properties" : {
+ "error_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "response_handle" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..http-action.template"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ },
+ "metabase.actions.schema.id" : {
+ "description" : "Valid Action ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.actions.schema.implicit-action" : {
+ "type" : "object",
+ "properties" : {
+ "kind" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ },
+ "metabase.actions.schema.query-action" : {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ },
+ "metabase.actions.schema.type" : {
+ "description" : "Unsupported action type",
+ "type" : "string",
+ "enum" : [ "http", "implicit", "query" ]
+ },
+ "metabase.actions.types..scope.raw" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dashboard-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "dashboard-id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "dashcard-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "dashcard-id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "card-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "card-id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "model-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "model-id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "table-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "table-id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "webhook-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "webhook-id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "unknown" : {
+ "type" : "string",
+ "enum" : [ "model-action" ]
+ }
+ },
+ "required" : [ "unknown" ]
} ]
},
- "metabase-enterprise.metabot-v3.tools.api.search-arguments" : {
+ "metabase.agent-api.api.column-metadata" : {
+ "description" : "Metadata for a single result column.",
+ "type" : "object",
+ "properties" : {
+ "base_type" : {
+ "type" : "string"
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "effective_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "base_type", "display_name" ]
+ },
+ "metabase.agent-api.api.construct-query-metric-request" : {
+ "description" : "Request schema for constructing a query from a metric.\n Only supports filters and group_by (aggregation is defined by the metric).",
"allOf" : [ {
"type" : "object",
"properties" : {
- "weights" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "number"
- }
- },
- "semantic_queries" : {
+ "filters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.filter"
}
}, {
"type" : "null"
} ]
},
- "limit" : {
- "default" : 50,
- "type" : "integer"
+ "group_by" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.group-by"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "database_id" : {
+ "metric_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "metric_id" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.agent-api.api.construct-query-request" : {
+ "description" : "Request schema for /v1/construct-query. Accepts either table_id or metric_id.",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-table-request"
+ }, {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-metric-request"
+ } ]
+ },
+ "metabase.agent-api.api.construct-query-response" : {
+ "description" : "Response containing a base64-encoded MBQL query for use with /v1/execute.",
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "query" ]
+ },
+ "metabase.agent-api.api.construct-query-table-request" : {
+ "description" : "Request schema for constructing a query from a table.\n\n Query components:\n - filters: Filter conditions to apply\n - fields: Specific fields to select (omit for all fields)\n - aggregations: Aggregation functions (sum, count, avg, etc.). Use sort_order on the aggregation to order by it.\n - group_by: Fields to group by, with optional temporal granularity\n - order_by: Order by regular fields only. To order by an aggregation result, use sort_order on the aggregation instead.\n - limit: Maximum rows to return",
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "aggregations" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.aggregation"
+ }
}, {
"type" : "null"
} ]
},
- "term_queries" : {
+ "fields" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.field"
}
}, {
"type" : "null"
} ]
},
- "entity_types" : {
+ "filters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "string",
- "enum" : [ "table", "model", "question", "dashboard", "metric", "database", "transform" ]
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.filter"
}
}, {
"type" : "null"
} ]
},
- "created_at" : {
+ "group_by" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.group-by"
+ }
}, {
"type" : "null"
} ]
},
- "last_edited_at" : {
+ "limit" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "search_native_query" : {
- "default" : false,
+ "order_by" : {
+ "description" : "Order by regular fields only. To order by aggregation results, use sort_order on the aggregation.",
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.order-by"
+ }
}, {
"type" : "null"
} ]
+ },
+ "table_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}
- }
+ },
+ "required" : [ "table_id" ]
}, {
"type" : "object",
"properties" : { }
} ]
},
- "metabase-enterprise.metabot-v3.tools.api.search-result" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "structured_output" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.search-result-item"
- }
- },
- "total_count" : {
- "type" : "integer"
+ "metabase.agent-api.api.entity-type" : {
+ "description" : "The type of queryable entity.",
+ "type" : "string",
+ "enum" : [ "table", "metric" ]
+ },
+ "metabase.agent-api.api.execute-query-request" : {
+ "description" : "Request schema for /v1/execute. Accepts a base64-encoded MBQL query.",
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "query" ]
+ },
+ "metabase.agent-api.api.execute-query-response" : {
+ "description" : "Response from query execution. The HTTP status is always 202 because results are streamed —\n check the `status` field to determine success or failure.",
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : {
+ "cols" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.column-metadata"
}
},
- "required" : [ "data", "total_count" ]
- }
+ "rows" : {
+ "type" : "array",
+ "items" : {
+ "type" : "array",
+ "items" : { }
+ }
+ }
+ },
+ "required" : [ "cols", "rows" ]
},
- "required" : [ "structured_output" ]
- }, {
- "type" : "object",
- "properties" : {
- "output" : {
- "type" : "string"
- }
+ "error" : {
+ "type" : "string"
},
- "required" : [ "output" ]
- } ]
+ "row_count" : {
+ "type" : "integer"
+ },
+ "running_time" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "completed", "failed" ]
+ }
+ },
+ "required" : [ "status" ]
},
- "metabase-enterprise.metabot-v3.tools.api.search-result-item" : {
- "description" : "Unified schema for search result items.",
+ "metabase.agent-api.api.field" : {
+ "description" : "A field from a table or metric. The field_id format is '<prefix><entity-id>-<field-index>' where prefix indicates the source (t=table, c=metric) and index is the position in the entity's fields.",
"type" : "object",
"properties" : {
- "collection" : {
+ "database_type" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : {
- "authority_level" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "verified" : {
+ "description" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "database_id" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "field_values" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "array",
+ "items" : { }
}, {
"type" : "null"
} ]
},
- "updated_at" : {
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "display_name" : {
+ "type" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field-type"
}, {
"type" : "null"
} ]
- },
- "type" : {
- "type" : "string",
- "enum" : [ "table", "model", "dashboard", "question", "metric", "database", "transform" ]
- },
- "database_schema" : {
+ }
+ },
+ "required" : [ "field_id", "name" ]
+ },
+ "metabase.agent-api.api.field-type" : {
+ "description" : "A data type for a field derived from Metabase's type hierarchy.",
+ "type" : "string",
+ "enum" : [ "boolean", "date", "datetime", "time", "number", "string" ]
+ },
+ "metabase.agent-api.api.field-values" : {
+ "description" : "Statistics and sample values for a specific field.",
+ "type" : "object",
+ "properties" : {
+ "field_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "created_at" : {
+ "statistics" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.statistics"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "values" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : { }
}, {
"type" : "null"
} ]
}
- },
- "required" : [ "id", "type", "name" ]
+ }
},
- "metabase-enterprise.metabot-v3.tools.api.segment" : {
+ "metabase.agent-api.api.measure" : {
+ "description" : "A reusable aggregation expression associated with a table. Reference via measure_id in the aggregations array.",
"type" : "object",
"properties" : {
- "definition" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
- },
"description" : {
"oneOf" : [ {
"type" : "string"
@@ -4750,432 +3652,244 @@
},
"required" : [ "id", "name" ]
},
- "metabase-enterprise.metabot-v3.tools.api.segment-filter" : {
- "description" : "Filter using a pre-defined segment.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "segment_id" : {
- "type" : "integer"
- }
- },
- "required" : [ "segment_id" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.statistics" : {
+ "metabase.agent-api.api.metric" : {
+ "description" : "A metric with its queryable dimensions and segments. The default_time_dimension_field_id is the field_id of the recommended time dimension for temporal breakouts.",
"type" : "object",
"properties" : {
- "values" : {
+ "default_time_dimension_field_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field-values"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "min" : {
+ "description" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "percent_url" : {
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "queryable_dimensions" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.proportion"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field"
+ }
}, {
"type" : "null"
} ]
},
- "average_length" : {
+ "segments" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.segment"
+ }
}, {
"type" : "null"
} ]
},
- "earliest" : {
+ "type" : {
+ "const" : "metric"
+ },
+ "verified" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
- },
- "q1" : {
+ }
+ },
+ "required" : [ "id", "type", "name" ]
+ },
+ "metabase.agent-api.api.metric-summary" : {
+ "description" : "Summary of a metric associated with a table. Includes the field_id of the default time dimension for temporal breakouts.",
+ "type" : "object",
+ "properties" : {
+ "default_time_dimension_field_id" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "max" : {
+ "description" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "distinct_count" : {
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "const" : "metric"
+ }
+ },
+ "required" : [ "id", "type", "name" ]
+ },
+ "metabase.agent-api.api.related-table" : {
+ "description" : "A table related to the queried entity via foreign key. The related_by field indicates the FK field name.",
+ "type" : "object",
+ "properties" : {
+ "database_engine" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.count"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "percent_state" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.proportion"
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "type" : "integer"
},
- "percent_null" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.proportion"
- }, {
- "type" : "null"
- } ]
+ "name" : {
+ "type" : "string"
},
- "avg" : {
+ "database_id" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "sd" : {
+ "related_by" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "percent_email" : {
+ "display_name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.proportion"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "latest" : {
+ "type" : {
+ "const" : "table"
+ },
+ "fields" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field"
+ }
}, {
"type" : "null"
} ]
},
- "q3" : {
+ "database_schema" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "percent_json" : {
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.proportion"
+ "type" : "string"
}, {
"type" : "null"
} ]
}
- }
+ },
+ "required" : [ "id", "type", "name" ]
},
- "metabase-enterprise.metabot-v3.tools.api.string-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals", "string-contains", "string-not-contains", "string-starts-with", "string-ends-with" ]
- },
- "value" : {
- "type" : "string"
+ "metabase.agent-api.api.search-response" : {
+ "description" : "Search results containing tables and metrics matching the query.",
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.search-result-item"
}
},
- "required" : [ "field_id", "operation", "value" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.subscription-schedule" : {
- "allOf" : [ {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "frequency" : {
- "const" : "hourly"
- }
- },
- "required" : [ "frequency" ]
- }, {
- "type" : "object",
- "properties" : {
- "frequency" : {
- "const" : "daily"
- },
- "hour" : {
- "type" : "integer"
- }
- },
- "required" : [ "frequency", "hour" ]
- }, {
- "type" : "object",
- "properties" : {
- "day_of_week" : {
- "type" : "string",
- "enum" : [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ]
- },
- "frequency" : {
- "const" : "weekly"
- },
- "hour" : {
- "type" : "integer"
- }
- },
- "required" : [ "frequency", "hour", "day_of_week" ]
- }, {
- "type" : "object",
- "properties" : {
- "day_of_month" : {
- "type" : "string",
- "enum" : [ "first-calendar-day", "middle-of-month", "last-calendar-day", "first-sunday", "first-monday", "first-tuesday", "first-wednesday", "first-thursday", "first-friday", "first-saturday", "last-sunday", "last-monday", "last-tuesday", "last-wednesday", "last-thursday", "last-friday", "last-saturday" ]
- },
- "frequency" : {
- "const" : "monthly"
- },
- "hour" : {
- "type" : "integer"
- }
- },
- "required" : [ "frequency", "hour", "day_of_month" ]
- } ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
+ "total_count" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "data", "total_count" ]
},
- "metabase-enterprise.metabot-v3.tools.api.table-result" : {
+ "metabase.agent-api.api.search-result-item" : {
+ "description" : "A table or metric returned from search.",
"type" : "object",
"properties" : {
- "database_engine" : {
- "type" : "string"
- },
"id" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
- "database_id" : {
- "type" : "integer"
- },
- "related_tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.table-result"
- }
- },
- "related_by" : {
+ "verified" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "display_name" : {
- "type" : "string"
- },
- "segments" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.segment"
- }
- },
- "type" : {
- "type" : "string",
- "enum" : [ "model", "table" ]
- },
- "fields" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.columns"
- },
- "database_schema" : {
+ "database_id" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "metrics" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.basic-metric"
- }
- },
- "measures" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.measure"
- }
+ "updated_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
},
- "description" : {
+ "display_name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]
- },
- "metabase-enterprise.metabot-v3.tools.api.temporal-extraction-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "year-equals", "year-not-equals", "quarter-equals", "quarter-not-equals", "month-equals", "month-not-equals", "day-of-week-equals", "day-of-week-not-equals", "hour-equals", "hour-not-equals", "minute-equals", "minute-not-equals", "second-equals", "second-not-equals" ]
- },
- "value" : {
- "type" : "integer"
- }
- },
- "required" : [ "field_id", "operation", "value" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.api.temporal-filter" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "bucket" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.bucket"
- },
- "field_id" : {
- "type" : "string"
- },
- "operation" : {
- "type" : "string",
- "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ]
- },
- "value" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "integer"
- } ]
- }
},
- "required" : [ "field_id", "operation", "value" ]
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- },
- "metabase-enterprise.metabot-v3.tools.deftool.tool-request" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
+ "type" : {
"type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "enum" : [ "table", "metric" ]
},
- "profile_id" : {
+ "database_schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "conversation_id" ]
- },
- "metabase-enterprise.metabot-v3.tools.transforms.transform-source" : {
- "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
- },
- "metabase-enterprise.metabot-v3.tools.transforms.transform-target" : {
- "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
- },
- "metabase-enterprise.permission-debug.impl.group-id" : {
- "type" : "integer"
- },
- "metabase-enterprise.permission-debug.impl.perm-debug-info" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : { }
- },
- "decision" : {
- "type" : "string",
- "enum" : [ "allow", "denied", "limited" ]
- },
- "message" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "model-id" : {
- "type" : "string"
- },
- "model-type" : {
- "type" : "string",
- "enum" : [ "card", "invalid" ]
},
- "segment" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "enum" : [ "sandboxed", "impersonated", "routed" ]
- },
- "uniqueItems" : true
+ "created_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
},
- "suggestions" : {
- "type" : "object",
- "additionalProperties" : {
+ "description" : {
+ "oneOf" : [ {
"type" : "string"
- }
- }
- },
- "required" : [ "model-type", "model-id", "decision", "segment", "message", "data", "suggestions" ]
- },
- "metabase-enterprise.replacement.schema.check-replace-source-response" : {
- "type" : "object",
- "properties" : {
- "column_mappings" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column-mapping"
- }
- },
- "errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.error-type"
- }
- },
- "success" : {
- "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "success" ]
+ "required" : [ "id", "type", "name" ]
},
- "metabase-enterprise.replacement.schema.column" : {
+ "metabase.agent-api.api.segment" : {
+ "description" : "A predefined filter condition that can be applied to queries via the segment_id in filters.",
"type" : "object",
"properties" : {
- "base_type" : {
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
@@ -5183,9 +3897,6 @@
} ]
},
"display_name" : {
- "type" : "string"
- },
- "effective_type" : {
"oneOf" : [ {
"type" : "string"
}, {
@@ -5193,650 +3904,629 @@
} ]
},
"id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- }, {
- "type" : "null"
- } ]
+ "type" : "integer"
},
"name" : {
"type" : "string"
- },
- "semantic_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
}
},
- "required" : [ "id", "name", "display_name", "base_type", "effective_type", "semantic_type" ]
+ "required" : [ "id", "name" ]
},
- "metabase-enterprise.replacement.schema.column-mapping" : {
+ "metabase.agent-api.api.statistics" : {
+ "description" : "Statistical summary of a field's values computed during database sync. Includes counts, percentages, numeric summaries (min/max/avg/quartiles/sd), and date ranges.",
"type" : "object",
"properties" : {
- "errors" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.source-swap.schema.column-error"
- }
- },
- "source" : {
+ "min" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "target" : {
+ "percent_url" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column"
+ "type" : "number"
}, {
"type" : "null"
} ]
- }
- }
- },
- "metabase-enterprise.replacement.schema.error-type" : {
- "type" : "string",
- "enum" : [ "cycle-detected", "database-mismatch", "incompatible-implicit-joins" ]
- },
- "metabase-enterprise.replacement.schema.run" : {
- "type" : "object",
- "properties" : {
- "message" : {
+ },
+ "average_length" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "target_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
- },
- "user_id" : {
+ "earliest" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "progress" : {
+ "q1" : {
"oneOf" : [ {
"type" : "number"
}, {
"type" : "null"
} ]
},
- "target_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
- },
- "is_active" : {
+ "max" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
- },
- "source_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
- },
- "status" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-status"
- },
- "source_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
- },
- "end_time" : {
+ "distinct_count" : {
"oneOf" : [ {
- "type" : "string",
- "format" : "date-time"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "start_time" : {
- "type" : "string",
- "format" : "date-time"
- }
- },
- "required" : [ "id", "status", "is_active", "source_entity_type", "source_entity_id", "target_entity_type", "target_entity_id", "progress", "message", "user_id", "start_time", "end_time" ]
- },
- "metabase-enterprise.replacement.schema.run-id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "metabase-enterprise.replacement.schema.run-status" : {
- "type" : "string",
- "enum" : [ "pending", "started", "succeeded", "failed", "canceled", "timeout" ]
- },
- "metabase-enterprise.replacement.schema.source-entity-id" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
- } ]
- },
- "metabase-enterprise.replacement.schema.source-entity-type" : {
- "type" : "string",
- "enum" : [ "card", "table" ]
- },
- "metabase-enterprise.sandbox.schema.attribute-remappings" : {
- "description" : "value must be a valid attribute remappings map (attribute name -> remapped name)",
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "anyOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "percent_state" : {
+ "oneOf" : [ {
+ "type" : "number"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ "type" : "null"
} ]
- }
- }, {
- "type" : "null"
- } ]
- },
- "metabase-enterprise.support-access-grants.schema.create-grant-request" : {
- "description" : "Schema for POST /api/ee/support-access-grants request body.",
- "type" : "object",
- "properties" : {
- "grant_duration_minutes" : {
- "type" : "integer",
- "minimum" : 1,
- "maximum" : 10080
},
- "notes" : {
+ "percent_null" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1,
- "maxLength" : 255
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "ticket_number" : {
+ "avg" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1,
- "maxLength" : 100
+ "type" : "number"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "grant_duration_minutes" ]
- },
- "metabase-enterprise.support-access-grants.schema.current-grant-response" : {
- "description" : "Schema for GET /api/ee/support-access-grants/current response.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
- }, {
- "type" : "null"
- } ]
- },
- "metabase-enterprise.support-access-grants.schema.grant-response" : {
- "description" : "Schema for a support access grant object in API responses.",
- "type" : "object",
- "properties" : {
- "user_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
},
- "token" : {
+ "sd" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "user_name" : {
+ "percent_email" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "user_email" : {
+ "latest" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "grant_end_timestamp" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
- },
- "revoked_at" : {
+ "q3" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "revoked_by_user_id" : {
+ "percent_json" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "number"
}, {
"type" : "null"
} ]
+ }
+ }
+ },
+ "metabase.agent-api.api.table" : {
+ "description" : "Full details of a table including its fields, related tables, metrics, and segments.",
+ "type" : "object",
+ "properties" : {
+ "database_engine" : {
+ "type" : "string"
},
"id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "integer"
},
- "ticket_number" : {
+ "name" : {
+ "type" : "string"
+ },
+ "database_id" : {
+ "type" : "integer"
+ },
+ "related_tables" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.related-table"
+ }
}, {
"type" : "null"
} ]
},
- "updated_at" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ "display_name" : {
+ "type" : "string"
},
- "created_at" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ "segments" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.segment"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "notes" : {
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.entity-type"
+ },
+ "fields" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field"
+ }
+ },
+ "database_schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "grant_start_timestamp" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ "metrics" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.metric-summary"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "measures" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.agent-api.api.measure"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "id", "user_id", "user_name", "user_email", "ticket_number", "notes", "grant_start_timestamp", "grant_end_timestamp", "revoked_at", "revoked_by_user_id", "created_at", "updated_at" ]
+ "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]
},
- "metabase-enterprise.support-access-grants.schema.list-grants-response" : {
- "description" : "Schema for GET /api/ee/support-access-grants response (paginated list).",
+ "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" : [ {
+ "$ref" : "#/components/schemas/metabase.api-keys.schema..key.raw"
+ }, {
+ "type" : "string",
+ "pattern" : "^mb_.*{4}\\*+$"
+ } ]
+ },
+ "metabase.api-keys.schema..key.raw" : {
+ "description" : "Unhashed string of the form 'mb_<base-64-bytes>'.",
+ "type" : "string",
+ "minLength" : 12,
+ "maxLength" : 254
+ },
+ "metabase.api-keys.schema.id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.api-keys.schema.name" : {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 254
+ },
+ "metabase.api-keys.schema.prefix" : {
+ "description" : "Prefix string of an API Key, suitable for passing around unmasked. This must be unique.",
+ "type" : "string",
+ "minLength" : 7,
+ "maxLength" : 7
+ },
+ "metabase.cache.api..cache-strategy.base.ee" : {
"type" : "object",
"properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
- }
- },
- "limit" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "offset" : {
- "type" : "integer",
- "minimum" : 0
- },
- "total" : {
- "type" : "integer",
- "minimum" : 0
+ "type" : {
+ "type" : "string",
+ "enum" : [ "nocache", "ttl", "duration", "schedule" ]
}
},
- "required" : [ "data", "total", "limit", "offset" ]
+ "required" : [ "type" ]
},
- "metabase-enterprise.support-access-grants.schema.timestamp" : {
- "anyOf" : [ { }, { } ]
+ "metabase.cache.api..cache-strategy.base.oss" : {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string",
+ "enum" : [ "nocache", "ttl" ]
+ }
+ },
+ "required" : [ "type" ]
},
- "metabase-enterprise.transforms-inspector.schema.alert-trigger" : {
- "description" : "Definition for conditional alerts.\n FE evaluates condition against card results and shows alert if triggered.",
+ "metabase.cache.api..cache-strategy.ee" : {
+ "description" : "Schema for a caching strategy in EE when we have an premium token with `:cache-granular-controls`.",
+ "allOf" : [ {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.base.ee"
+ }, {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
+ }, {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
+ }, {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.duration"
+ }, {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.schedule"
+ } ]
+ } ]
+ },
+ "metabase.cache.api..cache-strategy.ee.duration" : {
"type" : "object",
"properties" : {
- "condition" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-condition"
- },
- "id" : {
- "type" : "string"
+ "duration" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "message" : {
- "type" : "string"
+ "refresh_automatically" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "metadata" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
+ "type" : {
+ "const" : "duration"
},
- "severity" : {
+ "unit" : {
"type" : "string",
- "enum" : [ "info", "warning", "error" ]
+ "enum" : [ "hours", "minutes", "seconds", "days" ]
}
},
- "required" : [ "id", "condition", "severity", "message" ]
+ "required" : [ "type", "duration", "unit" ],
+ "additionalProperties" : false
},
- "metabase-enterprise.transforms-inspector.schema.card" : {
- "description" : "A visualization card in the inspector output.\n\n Cards are generic - lens-specific data goes in :metadata.\n The :metadata map is opaque to the core but interpreted by\n lens-specific lib utilities on the frontend. ",
+ "metabase.cache.api..cache-strategy.ee.schedule" : {
"type" : "object",
"properties" : {
- "dataset_query" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.query"
- },
- "display" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.display-type"
- },
- "id" : {
- "type" : "string"
- },
- "metadata" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.card-metadata"
- },
- "section_id" : {
+ "refresh_automatically" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "title" : {
- "type" : "string"
+ "schedule" : {
+ "$ref" : "#/components/schemas/metabase.util.cron.CronScheduleString"
+ },
+ "type" : {
+ "const" : "schedule"
}
},
- "required" : [ "id", "title", "display", "dataset_query" ]
+ "required" : [ "type", "schedule" ],
+ "additionalProperties" : false
},
- "metabase-enterprise.transforms-inspector.schema.card-metadata" : {
- "description" : "Common metadata for join-related cards and triggers.",
+ "metabase.cache.api..cache-strategy.nocache" : {
"type" : "object",
"properties" : {
- "dedup_key" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.dedup-key"
- },
- "group_id" : {
- "type" : "string"
- },
- "group_order" : {
- "type" : "integer"
- },
- "card_type" : {
- "type" : "string"
- },
- "group_role" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.group-role"
- },
- "join_step" : {
- "type" : "integer"
- },
- "join_alias" : {
- "type" : "string"
- },
- "join_strategy" : {
- "type" : "string"
- },
- "depends_on_cards" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
+ "type" : {
+ "const" : "nocache"
}
- }
+ },
+ "required" : [ "type" ]
},
- "metabase-enterprise.transforms-inspector.schema.complexity" : {
- "description" : "Complexity estimate for a lens.",
+ "metabase.cache.api..cache-strategy.oss" : {
+ "description" : "Schema for a caching strategy (OSS)",
+ "allOf" : [ {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.base.oss"
+ }, {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
+ }, {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
+ } ]
+ } ]
+ },
+ "metabase.cache.api..cache-strategy.ttl" : {
"type" : "object",
"properties" : {
- "level" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity-level"
+ "min_duration_ms" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
},
- "score" : {
+ "multiplier" : {
+ "description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
+ },
+ "type" : {
+ "const" : "ttl"
}
},
- "required" : [ "level" ]
- },
- "metabase-enterprise.transforms-inspector.schema.complexity-level" : {
- "description" : "Estimated complexity/cost of generating a lens.",
- "type" : "string",
- "enum" : [ "fast", "slow", "very-slow" ]
- },
- "metabase-enterprise.transforms-inspector.schema.dedup-key" : {
- "description" : "Key for deduplicating identical queries across lenses.\n Typically a vector like [:table_count table-id].",
- "type" : "array",
- "items" : { }
+ "required" : [ "type", "multiplier", "min_duration_ms" ],
+ "additionalProperties" : false
},
- "metabase-enterprise.transforms-inspector.schema.discovery-response" : {
- "description" : "Response from lens discovery.",
+ "metabase.cache.api.cache-config-item" : {
"type" : "object",
"properties" : {
- "available_lenses" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-metadata"
- }
- },
- "description" : {
+ "collection" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "object",
+ "properties" : {
+ "authority_level" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ]
}, {
"type" : "null"
} ]
},
+ "model" : {
+ "type" : "string",
+ "enum" : [ "root", "database", "dashboard", "question" ]
+ },
+ "model_id" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
"name" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "sources" : {
+ "strategy" : {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type" ]
+ }
+ },
+ "required" : [ "model", "model_id", "strategy" ]
+ },
+ "metabase.cache.api.cache-config-list-response" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
+ "$ref" : "#/components/schemas/metabase.cache.api.cache-config-item"
}
},
- "status" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.inspector-status"
- },
- "target" : {
+ "limit" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.table"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "visited_fields" : {
+ "offset" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.visited-fields"
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
}, {
"type" : "null"
} ]
+ },
+ "total" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
}
},
- "required" : [ "name", "status", "sources", "available_lenses" ]
- },
- "metabase-enterprise.transforms-inspector.schema.display-type" : {
- "description" : "Valid display types for cards.",
- "type" : "string",
- "enum" : [ "bar", "row", "line", "area", "pie", "scalar", "gauge", "progress", "table", "hidden" ]
+ "required" : [ "data" ]
},
- "metabase-enterprise.transforms-inspector.schema.drill-lens" : {
- "description" : "A drill-down lens available from the current lens.",
+ "metabase.cache.api.cache-config-store-response" : {
"type" : "object",
"properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
- "type" : "string"
- },
"id" : {
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}
},
- "required" : [ "id", "display_name" ]
+ "required" : [ "id" ]
},
- "metabase-enterprise.transforms-inspector.schema.drill-lens-trigger" : {
- "description" : "Definition for conditional drill lens availability.\n FE evaluates condition and shows drill lens option if triggered.\n :params is passed to the drill lens when triggered.",
+ "metabase.cache.api.cache-invalidate-response" : {
"type" : "object",
"properties" : {
- "condition" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-condition"
- },
- "lens_id" : {
- "type" : "string"
- },
- "metadata" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.trigger-metadata"
- },
- "params" : {
+ "body" : {
"type" : "object",
- "additionalProperties" : { }
+ "properties" : {
+ "count" : {
+ "type" : "integer"
+ },
+ "message" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "count", "message" ]
},
- "reason" : {
- "type" : "string"
+ "status" : {
+ "type" : "integer",
+ "enum" : [ 200, 404 ]
}
},
- "required" : [ "lens_id", "condition" ]
+ "required" : [ "status", "body" ]
},
- "metabase-enterprise.transforms-inspector.schema.field" : {
- "description" : "Field metadata for inspector.",
+ "metabase.cache.api.cache-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee"
+ }, {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.oss"
+ } ]
+ },
+ "metabase.channel.models.channel.Channel" : {
+ "description" : "Channel schema.",
"type" : "object",
"properties" : {
- "base_type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "active" : {
+ "type" : "boolean"
},
- "display_name" : {
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer",
- "minimum" : 1
+ "details" : {
+ "type" : "object",
+ "properties" : { }
},
"name" : {
"type" : "string"
},
- "semantic_type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
- },
- "stats" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.field-stats"
- }, {
- "type" : "null"
- } ]
+ "type" : {
+ "type" : "string"
}
},
- "required" : [ "id", "name", "base_type" ]
+ "required" : [ "name", "type", "details" ]
},
- "metabase-enterprise.transforms-inspector.schema.field-stats" : {
- "description" : "Statistics for a field from fingerprints.",
- "type" : "object",
- "properties" : {
- "min" : {
- "type" : "number"
- },
- "earliest" : {
- "type" : "string"
- },
- "q1" : {
- "type" : "number"
+ "metabase.channel.models.channel.ChannelTemplate" : {
+ "description" : "Channel Template schema.",
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "channel_type" : { },
+ "details" : {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateEmailDetails"
+ }
},
- "max" : {
- "type" : "number"
- },
- "distinct_count" : {
- "type" : "integer"
- },
- "nil_percent" : {
- "type" : "number"
- },
- "avg" : {
- "type" : "number"
+ "required" : [ "channel_type", "details" ]
+ }, { } ]
+ },
+ "metabase.channel.models.channel.ChannelTemplateEmailDetails" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "path" : {
+ "type" : "string"
+ },
+ "recipient-type" : {
+ "enum" : [ "cc", "bcc", "cc", "bcc" ]
+ },
+ "subject" : {
+ "type" : "string"
+ },
+ "type" : {
+ "enum" : [ "email/handlebars-resource", "email/handlebars-text", "email/handlebars-resource", "email/handlebars-text" ]
+ }
},
- "latest" : {
- "type" : "string"
+ "required" : [ "type", "subject", "path" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "string"
+ },
+ "recipient-type" : {
+ "enum" : [ "cc", "bcc", "cc", "bcc" ]
+ },
+ "subject" : {
+ "type" : "string"
+ },
+ "type" : {
+ "enum" : [ "email/handlebars-resource", "email/handlebars-text", "email/handlebars-resource", "email/handlebars-text" ]
+ }
},
- "q3" : {
- "type" : "number"
- }
- }
- },
- "metabase-enterprise.transforms-inspector.schema.group-role" : {
- "description" : "Role of a card within a comparison group.",
- "type" : "string",
- "enum" : [ "input", "output" ]
- },
- "metabase-enterprise.transforms-inspector.schema.inspector-status" : {
- "description" : "Status of the inspector result.",
- "type" : "string",
- "enum" : [ "not-run", "ready" ]
- },
- "metabase-enterprise.transforms-inspector.schema.layout-type" : {
- "description" : "Layout hints for sections.\n - :flat - cards displayed in a grid\n - :comparison - cards grouped for side-by-side comparison",
- "type" : "string",
- "enum" : [ "flat", "comparison" ]
+ "required" : [ "type", "subject", "body" ]
+ } ]
},
- "metabase-enterprise.transforms-inspector.schema.lens" : {
- "description" : "Full lens contents and drill lens/alert triggers.",
+ "metabase.channel.models.channel.ChannelTemplateEmailDetailsUserProvided" : {
+ "description" : "Email template details schema for API-provided templates. Only handlebars-text is allowed;\n handlebars-resource is restricted to internal use only.",
"type" : "object",
"properties" : {
- "complexity" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity"
- },
- "sections" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.section"
- }
- },
- "id" : {
+ "body" : {
"type" : "string"
},
- "summary" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens-summary"
- },
- "alert_triggers" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.alert-trigger"
- }
- },
- "drill_lenses" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.drill-lens"
- }
+ "recipient-type" : {
+ "enum" : [ "cc", "bcc", "cc", "bcc" ]
},
- "display_name" : {
+ "subject" : {
"type" : "string"
},
- "drill_lens_triggers" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.drill-lens-trigger"
- }
- },
- "cards" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.card"
- }
+ "type" : {
+ "enum" : [ "email/handlebars-text", "email/handlebars-text" ]
}
},
- "required" : [ "id", "display_name", "sections", "cards" ]
+ "required" : [ "type", "subject", "body" ]
},
- "metabase-enterprise.transforms-inspector.schema.lens-metadata" : {
+ "metabase.channel.models.channel.ChannelTemplateUserProvided" : {
+ "description" : "Channel Template schema for API-provided templates. Does not allow handlebars-resource.",
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "channel_type" : { },
+ "details" : {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateEmailDetailsUserProvided"
+ }
+ },
+ "required" : [ "channel_type", "details" ]
+ }, { } ]
+ },
+ "metabase.collections-rest.api.DashboardQuestionCandidate" : {
"type" : "object",
"properties" : {
- "complexity" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.complexity"
- },
"description" : {
"oneOf" : [ {
"type" : "string"
@@ -5844,2617 +4534,1469 @@
"type" : "null"
} ]
},
- "display_name" : {
- "type" : "string"
- },
"id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
"type" : "string"
+ },
+ "sole_dashboard_info" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "description" ]
}
},
- "required" : [ "id", "display_name" ]
+ "required" : [ "id", "name", "description", "sole_dashboard_info" ]
},
- "metabase-enterprise.transforms-inspector.schema.lens-summary" : {
- "description" : "Summary section of a lens.",
+ "metabase.collections-rest.api.DashboardQuestionCandidatesResponse" : {
"type" : "object",
"properties" : {
- "alerts" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
- },
- "highlights" : {
+ "data" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.summary-highlight"
+ "$ref" : "#/components/schemas/metabase.collections-rest.api.DashboardQuestionCandidate"
}
},
- "text" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "total" : {
+ "type" : "integer"
}
- }
+ },
+ "required" : [ "data", "total" ]
},
- "metabase-enterprise.transforms-inspector.schema.section" : {
- "description" : "A section grouping cards in a lens.",
+ "metabase.collections-rest.api.MoveDashboardQuestionCandidatesResponse" : {
"type" : "object",
"properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "string"
- },
- "layout" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.layout-type"
- },
- "title" : {
- "type" : "string"
+ "moved" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
}
},
- "required" : [ "id", "title" ]
+ "required" : [ "moved" ]
},
- "metabase-enterprise.transforms-inspector.schema.summary-highlight" : {
- "description" : "A highlight in the lens summary.",
+ "metabase.collections.schema.CardType" : {
+ "type" : "string",
+ "enum" : [ "model", "question", "metric" ]
+ },
+ "metabase.collections.schema.Collection" : {
"type" : "object",
"properties" : {
- "card_id" : {
- "type" : "string"
+ "git_sync_enabled" : {
+ "type" : "boolean"
},
- "label" : {
+ "can_delete" : {
+ "type" : "boolean"
+ },
+ "entity_id" : {
"type" : "string"
},
- "value" : {
- "oneOf" : [ { }, {
+ "authority_level" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
"type" : "null"
} ]
- }
- },
- "required" : [ "label" ]
- },
- "metabase-enterprise.transforms-inspector.schema.table" : {
- "description" : "Table metadata.",
- "type" : "object",
- "properties" : {
- "column_count" : {
- "type" : "integer"
},
- "db_id" : {
- "type" : "integer",
- "minimum" : 1
+ "is_sample" : {
+ "type" : "boolean"
},
- "fields" : {
+ "children" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.field"
+ "$ref" : "#/components/schemas/metabase.collections.schema.Collection"
}
},
- "schema" : {
- "oneOf" : [ {
+ "id" : {
+ "anyOf" : [ {
"type" : "string"
}, {
- "type" : "null"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
} ]
},
- "table_id" : {
- "type" : "integer",
- "minimum" : 1
+ "effective_ancestors" : {
+ "type" : "object",
+ "properties" : { }
},
- "table_name" : {
+ "effective_location" : {
"type" : "string"
- }
- },
- "required" : [ "table_id", "table_name", "db_id", "column_count", "fields" ]
- },
- "metabase-enterprise.transforms-inspector.schema.trigger-condition" : {
- "description" : "A named condition that triggers an alert or drill lens.\n Evaluated by multimethod in lib against card results.\n Only :name is required; other keys are condition-specific.",
- "type" : "object",
- "properties" : {
+ },
+ "is_remote_synced" : {
+ "type" : "boolean"
+ },
"name" : {
"type" : "string"
- }
- },
- "required" : [ "name" ]
- },
- "metabase-enterprise.transforms-inspector.schema.trigger-metadata" : {
- "description" : "Common metadata for join-related cards and triggers.",
- "type" : "object",
- "properties" : {
- "join_alias" : {
+ },
+ "slug" : {
"type" : "string"
},
- "join_step" : {
- "type" : "integer"
+ "archived" : {
+ "type" : "boolean"
},
- "join_strategy" : {
- "type" : "string"
- }
- }
- },
- "metabase-enterprise.transforms-inspector.schema.visited-fields" : {
- "description" : "Field IDs used in semantically important query clauses.\n Used for interestingness scoring and preselection.",
- "type" : "object",
- "properties" : {
- "all" : {
+ "location" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_write" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
+ },
+ "here" : {
"type" : "array",
"items" : {
- "type" : "integer",
- "minimum" : 1
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
},
"uniqueItems" : true
- }
- }
- },
- "metabase-enterprise.workspaces.types.ancestors-result" : {
- "description" : "Result of running stale ancestor transforms.",
- "type" : "object",
- "properties" : {
- "failed" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
},
- "not_run" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
+ "parent_id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "succeeded" : {
+ "can_restore" : {
+ "type" : "boolean"
+ },
+ "is_personal" : {
+ "type" : "boolean"
+ },
+ "personal_owner_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "below" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
}
- }
- },
- "required" : [ "succeeded", "failed", "not_run" ]
- },
- "metabase-enterprise.workspaces.types.appdb-id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "metabase-enterprise.workspaces.types.execution-result" : {
- "type" : "object",
- "properties" : {
- "ancestors" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ancestors-result"
- },
- "end_time" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
},
- "message" : {
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
- },
- "start_time" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "status" : {
- "type" : "string",
- "enum" : [ "succeeded", "failed" ]
- },
- "table" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "name" ]
}
},
- "required" : [ "status", "table" ]
- },
- "metabase-enterprise.workspaces.types.flag" : {
- "description" : "Boolean flag that accepts true, false, or 1 (for query param compatibility).",
- "anyOf" : [ {
- "const" : 1
- }, {
- "type" : "boolean"
- } ]
+ "required" : [ "id", "name", "description", "can_write", "can_restore", "can_delete", "archived", "location" ]
},
- "metabase-enterprise.workspaces.types.problem" : {
- "description" : "A problem detected during workspace validation.",
+ "metabase.collections.schema.CollectionItem" : {
"type" : "object",
"properties" : {
- "block_merge" : {
- "type" : "boolean"
- },
- "category" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.problem-category"
- },
- "data" : {
- "type" : "object",
- "properties" : { }
- },
- "problem" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.problem-name"
+ "last-edit-info" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.LastEditInfo"
},
- "severity" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.severity"
- }
- },
- "required" : [ "category", "problem", "severity", "block_merge", "data" ]
- },
- "metabase-enterprise.workspaces.types.problem-category" : {
- "type" : "string",
- "enum" : [ "external", "external-downstream", "unused", "internal", "internal-downstream" ]
- },
- "metabase-enterprise.workspaces.types.problem-name" : {
- "type" : "string",
- "enum" : [ "target-conflict", "not-run", "stale", "cycle", "failed", "removed-table", "removed-field" ]
- },
- "metabase-enterprise.workspaces.types.query-result" : {
- "description" : "Result of a query preview (dry-run or ad-hoc query).\n Data is nested under :data to match /api/dataset response format.",
- "type" : "object",
- "properties" : {
- "ancestors" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ancestors-result"
+ "model" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
},
- "data" : {
- "type" : "object",
- "properties" : {
- "cols" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
- },
- "results_metadata" : {
- "type" : "object",
- "properties" : {
- "columns" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
- }
- }
- },
- "rows" : {
- "type" : "array",
- "items" : { }
- }
- }
+ "copy" : {
+ "type" : "boolean"
},
- "message" : {
+ "collection_preview" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "running_time" : {
+ "dashboard_count" : {
"oneOf" : [ {
- "type" : "integer"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "started_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
+ "can_delete" : {
+ "type" : "boolean"
},
- "status" : {
- "type" : "string",
- "enum" : [ "succeeded", "failed" ]
- }
- },
- "required" : [ "status" ]
- },
- "metabase-enterprise.workspaces.types.ref-id" : {
- "type" : "string",
- "minLength" : 1
- },
- "metabase-enterprise.workspaces.types.severity" : {
- "type" : "string",
- "enum" : [ "error", "warning", "info" ]
- },
- "metabase.actions.schema..action.for-insert" : {
- "description" : "Schema for inserting a new Action (REST API or internally).",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "archived" : {
- "type" : "boolean"
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "model_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- },
- "name" : {
- "type" : "string"
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
- }, {
- "type" : "null"
- } ]
- },
- "parameters" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.type"
- },
- "visualization_settings" : {
- "oneOf" : [ {
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- }
+ "entity_id" : {
+ "type" : "string"
},
- "required" : [ "name", "type", "model_id" ]
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema.http-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.implicit-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.query-action"
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- } ]
- },
- "metabase.actions.schema..action.for-update" : {
- "description" : "Schema for updating an Action (REST API or internally).",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "visualization_settings" : {
- "oneOf" : [ {
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.id"
- },
- "name" : {
- "type" : "string"
- },
- "archived" : {
- "type" : "boolean"
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.type"
- },
- "model_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- },
- "parameters" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema.http-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.implicit-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.query-action"
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- } ]
- },
- "metabase.actions.schema..http-action.json-query" : {
- "description" : "must be a valid json-query, something like '.item.title'",
- "type" : "string"
- },
- "metabase.actions.schema..http-action.template" : {
- "type" : "object",
- "properties" : {
- "body" : {
+ "authority_level" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "headers" : {
+ "collection" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.collections.schema.Collection"
}, {
"type" : "null"
} ]
},
- "method" : {
- "type" : "string",
- "enum" : [ "GET", "POST", "PUT", "DELETE", "PATCH" ]
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "parameters" : {
+ "effective_location" : {
+ "type" : "string"
+ },
+ "fully_parameterized" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "url" : {
+ "name" : {
"type" : "string"
- }
- },
- "required" : [ "method", "url" ],
- "additionalProperties" : false
- },
- "metabase.actions.schema..implicit-action.kind" : {
- "description" : "Unsupported implicit action kind",
- "type" : "string",
- "enum" : [ "row/create", "row/update", "row/delete", "bulk/create", "bulk/update", "bulk/delete" ]
- },
- "metabase.actions.schema.action" : {
- "description" : "An Action as it should appear when we `SELECT` it from the app DB.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "visualization_settings" : {
- "oneOf" : [ {
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.id"
- },
- "made_public_by_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "archived" : {
- "type" : "boolean"
- },
- "updated_at" : { },
- "type" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.type"
- },
- "created_at" : { },
- "public_uuid" : {
- "oneOf" : [ {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- }, {
- "type" : "null"
- } ]
- },
- "model_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- },
- "parameters" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "location" : {
+ "type" : "string"
+ },
+ "database_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_write" : {
+ "type" : "boolean"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
- "type" : "null"
+ "type" : "string"
} ]
- },
- "creator_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "based_on_upload" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
"type" : "string"
- }, {
- "type" : "null"
} ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "moderated_status" : {
+ "type" : "string"
+ },
+ "type" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
+ }, {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CardType"
+ } ]
+ },
+ "here" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
+ },
+ "uniqueItems" : true
+ },
+ "display" : {
+ "type" : "string"
+ },
+ "can_restore" : {
+ "type" : "boolean"
+ },
+ "personal_owner_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "below" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
}
},
- "required" : [ "id" ]
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema.http-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.implicit-action"
- }, {
- "$ref" : "#/components/schemas/metabase.actions.schema.query-action"
- }, {
- "type" : "object",
- "properties" : { }
- } ]
- } ]
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "description", "archived" ]
},
- "metabase.actions.schema.http-action" : {
+ "metabase.collections.schema.CollectionItemModel" : {
+ "type" : "string",
+ "enum" : [ "card", "dataset", "metric", "dashboard", "snippet", "collection", "indexed-entity", "indexed-entity", "document", "table" ]
+ },
+ "metabase.collections.schema.CollectionType" : {
+ "type" : "string",
+ "enum" : [ "instance-analytics", "trash", "remote-synced", "library", "library-models", "library-metrics" ]
+ },
+ "metabase.collections.schema.LastEditInfo" : {
"type" : "object",
"properties" : {
- "error_handle" : {
+ "email" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "response_handle" : {
+ "first_name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema..http-action.json-query"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "template" : {
+ "id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema..http-action.template"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
- }
- }
- },
- "metabase.actions.schema.id" : {
- "description" : "Valid Action ID",
- "type" : "integer",
- "minimum" : 1
- },
- "metabase.actions.schema.implicit-action" : {
- "type" : "object",
- "properties" : {
- "kind" : {
+ },
+ "last_name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.actions.schema..implicit-action.kind"
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timestamp" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
}
- }
+ },
+ "required" : [ "id", "email", "first_name", "last_name", "timestamp" ]
},
- "metabase.actions.schema.query-action" : {
+ "metabase.data-studio.api.table.bulk-table-info" : {
+ "description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
"type" : "object",
"properties" : {
- "database_id" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_published" : {
+ "type" : "boolean"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ "type" : "string"
}, {
"type" : "null"
} ]
+ }
+ },
+ "required" : [ "id", "db_id", "name", "display_name", "schema", "is_published" ]
+ },
+ "metabase.data-studio.api.table.bulk-table-selection-info" : {
+ "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
+ "type" : "object",
+ "properties" : {
+ "published_downstream_tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ }
},
- "dataset_query" : {
+ "selected_table" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
}, {
"type" : "null"
} ]
+ },
+ "unpublished_upstream_tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ }
}
- }
+ },
+ "required" : [ "selected_table", "published_downstream_tables", "unpublished_upstream_tables" ]
},
- "metabase.actions.schema.type" : {
- "description" : "Unsupported action type",
+ "metabase.data-studio.api.table.data-authorities" : {
"type" : "string",
- "enum" : [ "http", "implicit", "query" ]
+ "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
},
- "metabase.actions.types..scope.raw" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "dashboard-id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "dashboard-id" ]
- }, {
- "type" : "object",
- "properties" : {
- "dashcard-id" : {
+ "metabase.data-studio.api.table.data-layers" : {
+ "type" : "string",
+ "enum" : [ "final", "internal", "hidden" ]
+ },
+ "metabase.data-studio.api.table.data-sources" : {
+ "type" : "string",
+ "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
+ },
+ "metabase.data-studio.api.table.table-selectors" : {
+ "type" : "object",
+ "properties" : {
+ "database_ids" : {
+ "type" : "array",
+ "items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
},
- "required" : [ "dashcard-id" ]
- }, {
- "type" : "object",
- "properties" : {
- "card-id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "schema_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
}
},
- "required" : [ "card-id" ]
- }, {
- "type" : "object",
- "properties" : {
- "model-id" : {
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
}
- },
- "required" : [ "model-id" ]
- }, {
- "type" : "object",
- "properties" : {
- "table-id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "table-id" ]
- }, {
- "type" : "object",
- "properties" : {
- "webhook-id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "webhook-id" ]
- }, {
- "type" : "object",
- "properties" : {
- "unknown" : {
- "type" : "string",
- "enum" : [ "model-action" ]
- }
- },
- "required" : [ "unknown" ]
- } ]
- },
- "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" : [ {
- "$ref" : "#/components/schemas/metabase.api-keys.schema..key.raw"
- }, {
- "type" : "string",
- "pattern" : "^mb_.*{4}\\*+$"
- } ]
- },
- "metabase.api-keys.schema..key.raw" : {
- "description" : "Unhashed string of the form 'mb_<base-64-bytes>'.",
- "type" : "string",
- "minLength" : 12,
- "maxLength" : 254
+ }
},
- "metabase.api-keys.schema.id" : {
- "description" : "value must be an integer greater than zero.",
+ "metabase.documents.schema..document.id" : {
+ "description" : "Valid Document ID",
"type" : "integer",
"minimum" : 1
},
- "metabase.api-keys.schema.name" : {
- "type" : "string",
- "minLength" : 1,
- "maxLength" : 254
- },
- "metabase.api-keys.schema.prefix" : {
- "description" : "Prefix string of an API Key, suitable for passing around unmasked. This must be unique.",
- "type" : "string",
- "minLength" : 7,
- "maxLength" : 7
- },
- "metabase.cache.api..cache-strategy.base.ee" : {
+ "metabase.documents.schema.document" : {
+ "description" : "Schema for an instance of a `:model/Document`.",
"type" : "object",
"properties" : {
- "type" : {
- "type" : "string",
- "enum" : [ "nocache", "ttl", "duration", "schedule" ]
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
}
},
- "required" : [ "type" ]
+ "required" : [ "id" ]
},
- "metabase.cache.api..cache-strategy.base.oss" : {
- "type" : "object",
- "properties" : {
- "type" : {
- "type" : "string",
- "enum" : [ "nocache", "ttl" ]
- }
- },
- "required" : [ "type" ]
+ "metabase.driver.connection.connection-type" : {
+ "type" : "string",
+ "enum" : [ "default", "write-data" ]
},
- "metabase.cache.api..cache-strategy.ee" : {
- "description" : "Schema for a caching strategy in EE when we have an premium token with `:cache-granular-controls`.",
+ "metabase.frontend-errors.api.frontend-error-type" : {
+ "type" : "string",
+ "enum" : [ "component-crash", "chart-render-error" ]
+ },
+ "metabase.legacy-mbql.schema.-" : {
+ "description" : "schema for a valid MBQL 4 :- clause",
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema..NativeQuery.Common" : {
"allOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.base.ee"
+ "type" : "object",
+ "properties" : {
+ "collection" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "template-tags" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagMap"
+ }
+ }
}, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.duration"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee.schedule"
- } ]
+ "allOf" : [ ]
} ]
},
- "metabase.cache.api..cache-strategy.ee.duration" : {
+ "metabase.legacy-mbql.schema..TemplateTag.Common" : {
+ "description" : "Things required by all template tag types.",
"type" : "object",
"properties" : {
- "duration" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "refresh_automatically" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
- "type" : {
- "const" : "duration"
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "unit" : {
- "type" : "string",
- "enum" : [ "hours", "minutes", "seconds", "days" ]
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagType"
}
},
- "required" : [ "type", "duration", "unit" ],
- "additionalProperties" : false
+ "required" : [ "type", "name", "display-name" ]
},
- "metabase.cache.api..cache-strategy.ee.schedule" : {
+ "metabase.legacy-mbql.schema..TemplateTag.FieldFilter" : {
+ "description" : "Things required by all template tag types.",
"type" : "object",
"properties" : {
- "refresh_automatically" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "required" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "const" : "dimension"
+ },
+ "alias" : {
+ "type" : "string"
+ },
+ "options" : {
+ "description" : "optional map to be appended to filter clause",
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.FieldFilter.Options"
}, {
"type" : "null"
} ]
},
- "schedule" : {
- "$ref" : "#/components/schemas/metabase.util.cron.CronScheduleString"
+ "dimension" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
},
- "type" : {
- "const" : "schedule"
+ "default" : { },
+ "widget-type" : {
+ "default" : "category",
+ "description" : "which type of widget the frontend should show for this Field Filter; this also affects which parameter types\n are allowed to be specified for it.",
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.WidgetType"
}
},
- "required" : [ "type", "schedule" ],
- "additionalProperties" : false
+ "required" : [ "type", "name", "display-name", "dimension", "widget-type" ]
},
- "metabase.cache.api..cache-strategy.nocache" : {
+ "metabase.legacy-mbql.schema..TemplateTag.FieldFilter.Options" : {
+ "type" : "object",
+ "additionalProperties" : { }
+ },
+ "metabase.legacy-mbql.schema..TemplateTag.RawValue" : {
+ "description" : "Things required by all template tag types.",
"type" : "object",
"properties" : {
+ "default" : { },
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "required" : {
+ "type" : "boolean"
+ },
"type" : {
- "const" : "nocache"
+ "type" : "string",
+ "enum" : [ "date", "number", "boolean", "text" ]
}
},
- "required" : [ "type" ]
- },
- "metabase.cache.api..cache-strategy.oss" : {
- "description" : "Schema for a caching strategy (OSS)",
- "allOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.base.oss"
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.nocache"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ttl"
- } ]
- } ]
+ "required" : [ "type", "name", "display-name" ]
},
- "metabase.cache.api..cache-strategy.ttl" : {
+ "metabase.legacy-mbql.schema..TemplateTag.Snippet" : {
+ "description" : "Things required by all template tag types.",
"type" : "object",
"properties" : {
- "min_duration_ms" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
+ "database" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
- "multiplier" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "snippet-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
+ },
+ "snippet-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"type" : {
- "const" : "ttl"
+ "const" : "snippet"
}
},
- "required" : [ "type", "multiplier", "min_duration_ms" ],
- "additionalProperties" : false
+ "required" : [ "type", "name", "display-name", "snippet-name", "snippet-id" ]
},
- "metabase.cache.api.cache-config-item" : {
+ "metabase.legacy-mbql.schema..TemplateTag.SourceFilter" : {
+ "description" : "Schema for a single source-filter applied to a table template tag.",
"type" : "object",
"properties" : {
- "collection" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "authority_level" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "name" ]
- }, {
- "type" : "null"
- } ]
+ "field-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
},
- "model" : {
+ "op" : {
"type" : "string",
- "enum" : [ "root", "database", "dashboard", "question" ]
+ "enum" : [ "<=", ">", ">=", "!=", "=", "<" ]
},
- "model_id" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
+ "value" : { }
+ },
+ "required" : [ "field-id", "op", "value" ]
+ },
+ "metabase.legacy-mbql.schema..TemplateTag.SourceQuery" : {
+ "description" : "Things required by all template tag types.",
+ "type" : "object",
+ "properties" : {
+ "card-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
},
"name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "strategy" : {
- "type" : "object",
- "properties" : {
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "type" ]
+ "type" : {
+ "const" : "card"
}
},
- "required" : [ "model", "model_id", "strategy" ]
+ "required" : [ "type", "name", "display-name", "card-id" ]
},
- "metabase.cache.api.cache-config-list-response" : {
+ "metabase.legacy-mbql.schema..TemplateTag.SourceTable" : {
+ "description" : "Things required by all template tag types.",
"type" : "object",
"properties" : {
- "data" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "emit-alias" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "source-filters" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.cache.api.cache-config-item"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.SourceFilter"
}
},
- "limit" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "offset" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
- }, {
- "type" : "null"
- } ]
+ "table-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
},
- "total" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
+ "type" : {
+ "const" : "table"
}
},
- "required" : [ "data" ]
+ "required" : [ "type", "name", "display-name", "table-id" ]
},
- "metabase.cache.api.cache-config-store-response" : {
+ "metabase.legacy-mbql.schema..TemplateTag.TemporalUnit" : {
+ "description" : "Things required by all template tag types.",
"type" : "object",
"properties" : {
+ "alias" : {
+ "type" : "string"
+ },
+ "default" : { },
+ "dimension" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
+ },
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
"id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "required" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "const" : "temporal-unit"
}
},
- "required" : [ "id" ]
+ "required" : [ "type", "name", "display-name", "dimension" ]
},
- "metabase.cache.api.cache-invalidate-response" : {
+ "metabase.legacy-mbql.schema..TemplateTag.Value.Common" : {
+ "description" : "Things required by all template tag types.",
"type" : "object",
"properties" : {
- "body" : {
- "type" : "object",
- "properties" : {
- "count" : {
- "type" : "integer"
- },
- "message" : {
- "type" : "string"
- }
- },
- "required" : [ "count", "message" ]
+ "default" : { },
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "status" : {
- "type" : "integer",
- "enum" : [ 200, 404 ]
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "required" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagType"
}
},
- "required" : [ "status", "body" ]
+ "required" : [ "type", "name", "display-name" ]
},
- "metabase.cache.api.cache-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.oss"
- } ]
+ "metabase.legacy-mbql.schema..legacy-column-metadata.binning-info" : {
+ "type" : "object",
+ "properties" : {
+ "bin_width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
+ },
+ "binning_strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ },
+ "num_bins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
+ },
+ "strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ }
+ },
+ "required" : [ "strategy" ]
},
- "metabase.channel.models.channel.Channel" : {
- "description" : "Channel schema.",
+ "metabase.legacy-mbql.schema..legacy-column-metadata.qualified-keys" : {
"type" : "object",
"properties" : {
- "active" : {
- "type" : "boolean"
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
},
- "description" : {
+ "lib/external-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/source-column-alias" : {
"oneOf" : [ {
+ "description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
"type" : "string"
}, {
"type" : "null"
} ]
},
- "details" : {
- "type" : "object",
- "properties" : { }
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "default", "hour", "hour-of-day", "millisecond", "minute", "minute-of-hour", "month", "month-of-year", "quarter", "quarter-of-year", "second", "second-of-minute", "week", "week-of-year", "year", "year-of-era" ]
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "type" : "string"
+ "lib/type" : {
+ "default" : "metadata/column",
+ "const" : "metadata/column"
},
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "name", "type", "details" ]
- },
- "metabase.channel.models.channel.ChannelTemplate" : {
- "description" : "Channel Template schema.",
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "channel_type" : { },
- "details" : {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateEmailDetails"
- }
- },
- "required" : [ "channel_type", "details" ]
- }, { } ]
- },
- "metabase.channel.models.channel.ChannelTemplateEmailDetails" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "path" : {
- "type" : "string"
- },
- "recipient-type" : {
- "enum" : [ "cc", "bcc", "cc", "bcc" ]
- },
- "subject" : {
- "type" : "string"
- },
- "type" : {
- "enum" : [ "email/handlebars-resource", "email/handlebars-text", "email/handlebars-resource", "email/handlebars-text" ]
- }
- },
- "required" : [ "type", "subject", "path" ]
- }, {
- "type" : "object",
- "properties" : {
- "body" : {
- "type" : "string"
- },
- "recipient-type" : {
- "enum" : [ "cc", "bcc", "cc", "bcc" ]
- },
- "subject" : {
- "type" : "string"
- },
- "type" : {
- "enum" : [ "email/handlebars-resource", "email/handlebars-text", "email/handlebars-resource", "email/handlebars-text" ]
- }
- },
- "required" : [ "type", "subject", "body" ]
- } ]
- },
- "metabase.channel.models.channel.ChannelTemplateEmailDetailsUserProvided" : {
- "description" : "Email template details schema for API-provided templates. Only handlebars-text is allowed;\n handlebars-resource is restricted to internal use only.",
- "type" : "object",
- "properties" : {
- "body" : {
- "type" : "string"
- },
- "recipient-type" : {
- "enum" : [ "cc", "bcc", "cc", "bcc" ]
- },
- "subject" : {
- "type" : "string"
- },
- "type" : {
- "enum" : [ "email/handlebars-text", "email/handlebars-text" ]
- }
- },
- "required" : [ "type", "subject", "body" ]
- },
- "metabase.channel.models.channel.ChannelTemplateUserProvided" : {
- "description" : "Channel Template schema for API-provided templates. Does not allow handlebars-resource.",
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "channel_type" : { },
- "details" : {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateEmailDetailsUserProvided"
- }
- },
- "required" : [ "channel_type", "details" ]
- }, { } ]
- },
- "metabase.collections-rest.api.DashboardQuestionCandidate" : {
- "type" : "object",
- "properties" : {
- "description" : {
+ "lib/source-uuid" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
}, {
"type" : "null"
} ]
},
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string"
- },
- "sole_dashboard_info" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name", "description" ]
- }
- },
- "required" : [ "id", "name", "description", "sole_dashboard_info" ]
- },
- "metabase.collections-rest.api.DashboardQuestionCandidatesResponse" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections-rest.api.DashboardQuestionCandidate"
- }
- },
- "total" : {
- "type" : "integer"
- }
- },
- "required" : [ "data", "total" ]
- },
- "metabase.collections-rest.api.MoveDashboardQuestionCandidatesResponse" : {
- "type" : "object",
- "properties" : {
- "moved" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- }
- },
- "required" : [ "moved" ]
- },
- "metabase.collections.schema.CardType" : {
- "type" : "string",
- "enum" : [ "model", "question", "metric" ]
- },
- "metabase.collections.schema.Collection" : {
- "type" : "object",
- "properties" : {
- "git_sync_enabled" : {
- "type" : "boolean"
- },
- "can_delete" : {
- "type" : "boolean"
- },
- "entity_id" : {
- "type" : "string"
- },
- "authority_level" : {
+ "qp/implicit-field?" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "is_sample" : {
- "type" : "boolean"
- },
- "children" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.Collection"
- }
- },
- "id" : {
- "anyOf" : [ {
+ "lib/ref-name" : {
+ "oneOf" : [ {
"type" : "string"
}, {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "null"
} ]
},
- "effective_ancestors" : {
- "type" : "object",
- "properties" : { }
- },
- "effective_location" : {
- "type" : "string"
- },
- "is_remote_synced" : {
- "type" : "boolean"
- },
- "name" : {
- "type" : "string"
- },
- "slug" : {
- "type" : "string"
- },
- "archived" : {
- "type" : "boolean"
- },
- "location" : {
+ "lib/deduplicated-name" : {
+ "description" : "The simply-deduplicated name that was historically used in QP results metadata (originally calculated by\n the [[metabase.query-processor.middleware.annotate]] middleware, now calculated\n by [[metabase.lib.middleware.result-metadata]]). This just adds suffixes to column names e.g. `ID` and `ID` become\n `ID` and `ID_2`, respectively. Kept around because many old field refs use this column name.",
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "can_write" : {
- "type" : "boolean"
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
- },
- "here" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- },
- "uniqueItems" : true
- },
- "parent_id" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- } ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "can_restore" : {
- "type" : "boolean"
- },
- "is_personal" : {
- "type" : "boolean"
- },
- "personal_owner_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "below" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- }
- },
- "description" : {
+ "lib/original-expression-name" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "id", "name", "description", "can_write", "can_restore", "can_delete", "archived", "location" ]
- },
- "metabase.collections.schema.CollectionItem" : {
- "type" : "object",
- "properties" : {
- "last-edit-info" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.LastEditInfo"
- },
- "model" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- },
- "copy" : {
- "type" : "boolean"
},
- "collection_preview" : {
+ "lib/from-model?" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "dashboard_count" : {
+ "lib/card-id" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "Valid Card ID",
"type" : "integer",
"minimum" : 1
}, {
"type" : "null"
} ]
},
- "can_delete" : {
- "type" : "boolean"
- },
- "entity_id" : {
- "type" : "string"
- },
- "authority_level" : {
+ "lib/expression-name" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "collection" : {
+ "lib/breakout?" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.collections.schema.Collection"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "effective_location" : {
- "type" : "string"
- },
- "fully_parameterized" : {
+ "lib/original-effective-type" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string"
- },
- "archived" : {
- "type" : "boolean"
- },
- "collection_position" : {
+ "lib/join-alias" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "location" : {
- "type" : "string"
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
},
- "database_id" : {
+ "lib/internal-remap" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
}, {
"type" : "null"
} ]
},
- "can_write" : {
- "type" : "boolean"
- },
- "collection_id" : {
+ "lib/original-binning" : {
"oneOf" : [ {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "description" : "Schema for `:binning` options passed to a `:field` clause.",
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ }
+ },
+ "required" : [ "strategy" ]
}, {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "const" : "default"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
+ },
+ "strategy" : {
+ "const" : "bin-width"
+ }
+ },
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
+ },
+ "strategy" : {
+ "const" : "num-bins"
+ }
+ },
+ "required" : [ "strategy", "num-bins" ]
+ } ]
} ]
}, {
"type" : "null"
} ]
},
- "based_on_upload" : {
+ "lib/original-join-alias" : {
"oneOf" : [ {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "string"
- } ]
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "moderated_status" : {
- "type" : "string"
- },
- "type" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionType"
+ "lib/original-display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
- "$ref" : "#/components/schemas/metabase.collections.schema.CardType"
+ "type" : "null"
} ]
},
- "here" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- },
- "uniqueItems" : true
- },
- "display" : {
+ "qp/native-sandbox-column.force-coercion-strategy" : {
"type" : "string"
},
- "can_restore" : {
- "type" : "boolean"
- },
- "personal_owner_id" : {
+ "lib/binning" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "description" : "Schema for `:binning` options passed to a `:field` clause.",
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "const" : "default"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
+ },
+ "strategy" : {
+ "const" : "bin-width"
+ }
+ },
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
+ },
+ "strategy" : {
+ "const" : "num-bins"
+ }
+ },
+ "required" : [ "strategy", "num-bins" ]
+ } ]
+ } ]
}, {
"type" : "null"
} ]
},
- "below" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItemModel"
- }
- },
- "description" : {
+ "metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "id", "name", "description", "archived" ]
- },
- "metabase.collections.schema.CollectionItemModel" : {
- "type" : "string",
- "enum" : [ "card", "dataset", "metric", "dashboard", "snippet", "collection", "indexed-entity", "indexed-entity", "document", "table" ]
- },
- "metabase.collections.schema.CollectionType" : {
- "type" : "string",
- "enum" : [ "instance-analytics", "trash", "remote-synced", "library", "library-models", "library-metrics" ]
- },
- "metabase.collections.schema.LastEditInfo" : {
- "type" : "object",
- "properties" : {
- "email" : {
+ },
+ "lib/source" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
}, {
"type" : "null"
} ]
},
- "first_name" : {
+ "lib/ref-display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
+ "lib/original-name" : {
+ "description" : "The original name of the column as it appeared in the very first place it came from (i.e., the physical name of the\n column in the table it appears in). This should be the same as the `:lib/source-column-alias` for the very first\n usage of the column.\n Allowed to be blank because some databases like SQL Server allow blank column names.",
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "last_name" : {
+ "lib/simple-display-name" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "timestamp" : {
+ "lib/desired-column-alias" : {
"oneOf" : [ {
+ "description" : "Name we should use as a column alias for a column in this stage of a query. The desired column alias in stage N\n becomes the source column alias in stage N+1. The right-hand side (RHS) in\n\n SELECT lhs AS rhs",
"type" : "string"
}, {
"type" : "null"
} ]
}
- },
- "required" : [ "id", "email", "first_name", "last_name", "timestamp" ]
+ }
},
- "metabase.data-studio.api.table.bulk-table-info" : {
- "description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
- "type" : "object",
- "properties" : {
- "db_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "display_name" : {
- "type" : "string"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_published" : {
- "type" : "boolean"
+ "metabase.legacy-mbql.schema.Addable" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpressionArg"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DateTimeExpressionArg"
+ }, {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.interval"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.segment"
+ } ]
+ } ]
+ },
+ "metabase.legacy-mbql.schema.Aggregation" : {
+ "description" : "Schema for anything that is a valid `:aggregation` clause.",
+ "allOf" : [ {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation-options"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.UnnamedAggregation"
+ } ]
+ }, {
+ "description" : "Normalization should automatically unwrap :aggregation-options with an empty options map"
+ } ]
+ },
+ "metabase.legacy-mbql.schema.AggregationOptionsOptions" : {
+ "description" : "Additional options for any aggregation clause when wrapping it in `:aggregation-options`.",
+ "type" : "object",
+ "properties" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"name" : {
- "type" : "string"
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
- },
- "required" : [ "id", "db_id", "name", "display_name", "schema", "is_published" ]
+ }
},
- "metabase.data-studio.api.table.bulk-table-selection-info" : {
- "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
+ "metabase.legacy-mbql.schema.AggregationRefOptions" : {
"type" : "object",
"properties" : {
- "published_downstream_tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
- }
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
},
- "selected_table" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "unpublished_upstream_tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
- }
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
+ }
+ },
+ "metabase.legacy-mbql.schema.Aggregations" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
},
- "required" : [ "selected_table", "published_downstream_tables", "unpublished_upstream_tables" ]
+ "minItems" : 1
},
- "metabase.data-studio.api.table.data-authorities" : {
- "type" : "string",
- "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
+ "metabase.legacy-mbql.schema.AnyMBQLClause" : {
+ "description" : "Schema for ANY valid MBQL clause"
},
- "metabase.data-studio.api.table.data-layers" : {
+ "metabase.legacy-mbql.schema.ArithmeticDateTimeUnit" : {
"type" : "string",
- "enum" : [ "final", "internal", "hidden" ]
+ "enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year" ]
},
- "metabase.data-studio.api.table.data-sources" : {
- "type" : "string",
- "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
+ "metabase.legacy-mbql.schema.BooleanExpression" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.and"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.or"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._EQ_"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._BANG__EQ_"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT_"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT_"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT__EQ_"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT__EQ_"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.between"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.starts-with"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ends-with"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.contains"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.in"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not-in"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.does-not-contain"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.inside"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.is-empty"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not-empty"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.is-null"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not-null"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.relative-time-interval"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.time-interval"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.during"
+ } ]
},
- "metabase.data-studio.api.table.table-selectors" : {
+ "metabase.legacy-mbql.schema.Breakouts" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
+ },
+ "minItems" : 1
+ },
+ "metabase.legacy-mbql.schema.CaseOptions" : {
"type" : "object",
"properties" : {
- "database_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "schema_ids" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "table_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
+ "default" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
}
}
},
- "metabase.documents.schema..document.id" : {
- "description" : "Valid Document ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.legacy-mbql.schema.CaseSubclause" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
+ } ]
},
- "metabase.documents.schema.document" : {
- "description" : "Schema for an instance of a `:model/Document`.",
- "type" : "object",
- "properties" : {
- "id" : {
- "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
- }
+ "metabase.legacy-mbql.schema.CaseSubclauses" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.CaseSubclause"
},
- "required" : [ "id" ]
+ "minItems" : 1
},
- "metabase.driver.connection.connection-type" : {
+ "metabase.legacy-mbql.schema.CheckKeysForQueryType" : {
+ "allOf" : [ ]
+ },
+ "metabase.legacy-mbql.schema.CheckQueryDoesNotHaveSourceMetadata" : {
+ "description" : "`:source-metadata` is added to queries when `card__id` source queries are resolved. It contains info about the\n columns in the source query.\n\n Where this is added was changed in Metabase 0.33.0 -- previously, when `card__id` source queries were resolved, the\n middleware would add `:source-metadata` to the top-level; to support joins against source queries, this has been\n changed so it is always added at the same level the resolved `:source-query` is added.\n\n This should automatically be fixed by `normalize`; if we encounter it, it means some middleware is not functioning\n properly."
+ },
+ "metabase.legacy-mbql.schema.DatabaseID" : {
+ "description" : "Schema for a valid `:database` ID, in the top-level 'outer' query. Either a positive integer (referring to an\n actual Database), or the saved questions virtual ID, which is a placeholder used for queries using the\n `:source-table \"card__id\"` shorthand for a source query resolved by middleware (since clients might not know the\n actual DB for that source query.)",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ } ]
+ },
+ "metabase.legacy-mbql.schema.DateOrDatetimeLiteral" : {
+ "description" : "Schema for a valid date or datetime literal.",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.relative-datetime"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.absolute-datetime"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.datetime"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.date"
+ } ]
+ },
+ "metabase.legacy-mbql.schema.DateTimeExpressionArg" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeExpression"
+ }, {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DateOrDatetimeLiteral"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
+ } ]
+ } ]
+ },
+ "metabase.legacy-mbql.schema.DateTimeUnit" : {
+ "description" : "Valid unit for *datetime* bucketing.",
"type" : "string",
- "enum" : [ "default", "write-data" ]
+ "enum" : [ "quarter", "day", "hour", "week", "second", "default", "day-of-week", "hour-of-day", "month", "month-of-year", "day-of-month", "year", "day-of-year", "millisecond", "year-of-era", "week-of-year", "quarter-of-year", "minute-of-hour", "minute" ]
},
- "metabase.legacy-mbql.schema.-" : {
- "description" : "schema for a valid MBQL 4 :- clause",
- "allOf" : [ ]
+ "metabase.legacy-mbql.schema.DateUnit" : {
+ "description" : "Valid unit for date bucketing.",
+ "type" : "string",
+ "enum" : [ "quarter", "day", "week", "default", "day-of-week", "month", "month-of-year", "day-of-month", "year", "day-of-year", "year-of-era", "week-of-year", "quarter-of-year" ]
},
- "metabase.legacy-mbql.schema..NativeQuery.Common" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "collection" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "template-tags" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagMap"
- }
- }
+ "metabase.legacy-mbql.schema.DatetimeDiffUnit" : {
+ "description" : "Valid units for a datetime-diff clause.",
+ "type" : "string",
+ "enum" : [ "second", "minute", "hour", "day", "week", "month", "quarter", "year" ]
+ },
+ "metabase.legacy-mbql.schema.DatetimeExpression" : {
+ "description" : "Schema for the definition of a date function expression.",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._PLUS_"
}, {
- "allOf" : [ ]
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime-add"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime-subtract"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.convert-timezone"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.now"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.date"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.today"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.coalesce"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.case"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.if"
} ]
},
- "metabase.legacy-mbql.schema..TemplateTag.Common" : {
- "description" : "Things required by all template tag types.",
+ "metabase.legacy-mbql.schema.DatetimeOptions" : {
"type" : "object",
"properties" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagType"
+ "mode" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeOptionsMode"
}
- },
- "required" : [ "type", "name", "display-name" ]
+ }
},
- "metabase.legacy-mbql.schema..TemplateTag.FieldFilter" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "required" : {
+ "metabase.legacy-mbql.schema.DatetimeOptionsMode" : {
+ "type" : "string",
+ "enum" : [ "simple-bytes", "unix-nanoseconds", "simple", "iso", "iso-bytes", "unix-seconds", "unix-milliseconds", "unix-microseconds" ]
+ },
+ "metabase.legacy-mbql.schema.Emptyable" : {
+ "description" : "Schema for a valid is-empty or not-empty argument.",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.StringExpressionArg"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
+ } ]
+ },
+ "metabase.legacy-mbql.schema.EqualityComparable" : {
+ "description" : "Schema for things that make sense in a `=` or `!=` filter, i.e. things that can be compared for equality.",
+ "oneOf" : [ {
+ "anyOf" : [ {
"type" : "boolean"
- },
- "type" : {
- "const" : "dimension"
- },
- "alias" : {
+ }, {
+ "type" : "number"
+ }, {
"type" : "string"
- },
- "options" : {
- "description" : "optional map to be appended to filter clause",
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemporalLiteral"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRefOrRelativeDatetime"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.legacy-mbql.schema.EqualityFilterFieldArg" : {
+ "description" : "Schema for the first arg to `=`, `!=`, and friends.",
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.EqualityComparable"
+ },
+ "metabase.legacy-mbql.schema.ExpressionArg" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "boolean"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.BooleanExpression"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpression"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeExpression"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation"
+ }, {
+ "type" : "string"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.StringExpression"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
+ } ]
+ },
+ "metabase.legacy-mbql.schema.ExpressionName" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "metabase.legacy-mbql.schema.ExpressionRefOptions" : {
+ "description" : "Options for a legacy `:expression` ref in MBQL 4 are the same as in MBQL 5, except that `:lib/uuid` is optional and\n it cannot be empty.",
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.FieldFilter.Options"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "dimension" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
+ "database-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
},
- "default" : { },
- "widget-type" : {
- "default" : "category",
- "description" : "which type of widget the frontend should show for this Field Filter; this also affects which parameter types\n are allowed to be specified for it.",
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.WidgetType"
- }
- },
- "required" : [ "type", "name", "display-name", "dimension", "widget-type" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.FieldFilter.Options" : {
- "type" : "object",
- "additionalProperties" : { }
- },
- "metabase.legacy-mbql.schema..TemplateTag.RawValue" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "default" : { },
"display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : {
- "type" : "boolean"
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
+ "lib/uuid" : {
"type" : "string",
- "enum" : [ "date", "number", "boolean", "text" ]
- }
- },
- "required" : [ "type", "name", "display-name" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.Snippet" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "database" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "minLength" : 36,
+ "maxLength" : 36
},
"name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "snippet-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
},
- "snippet-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "const" : "snippet"
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}
- },
- "required" : [ "type", "name", "display-name", "snippet-name", "snippet-id" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.SourceFilter" : {
- "description" : "Schema for a single source-filter applied to a table template tag.",
- "type" : "object",
- "properties" : {
- "field-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "op" : {
- "type" : "string",
- "enum" : [ "<=", ">", ">=", "!=", "=", "<" ]
- },
- "value" : { }
- },
- "required" : [ "field-id", "op", "value" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.SourceQuery" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "card-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "type" : {
- "const" : "card"
- }
- },
- "required" : [ "type", "name", "display-name", "card-id" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.SourceTable" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "emit-alias" : {
- "type" : "boolean"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "source-filters" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.SourceFilter"
- }
- },
- "table-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
- },
- "type" : {
- "const" : "table"
- }
- },
- "required" : [ "type", "name", "display-name", "table-id" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.TemporalUnit" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "alias" : {
- "type" : "string"
- },
- "default" : { },
- "dimension" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "required" : {
- "type" : "boolean"
- },
- "type" : {
- "const" : "temporal-unit"
- }
- },
- "required" : [ "type", "name", "display-name", "dimension" ]
- },
- "metabase.legacy-mbql.schema..TemplateTag.Value.Common" : {
- "description" : "Things required by all template tag types.",
- "type" : "object",
- "properties" : {
- "default" : { },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "required" : {
- "type" : "boolean"
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemplateTagType"
- }
- },
- "required" : [ "type", "name", "display-name" ]
- },
- "metabase.legacy-mbql.schema..legacy-column-metadata.binning-info" : {
- "type" : "object",
- "properties" : {
- "bin_width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
- },
- "binning_strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
- },
- "num_bins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
- },
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
- }
- },
- "required" : [ "strategy" ]
- },
- "metabase.legacy-mbql.schema..legacy-column-metadata.qualified-keys" : {
- "type" : "object",
- "properties" : {
- "metabase.lib.metadata.result-metadata/field-ref" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
- }, {
- "type" : "null"
- } ]
- },
- "lib/external-remap" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
- }, {
- "type" : "null"
- } ]
- },
- "lib/source-column-alias" : {
- "oneOf" : [ {
- "description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/temporal-unit" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "default", "hour", "hour-of-day", "millisecond", "minute", "minute-of-hour", "month", "month-of-year", "quarter", "quarter-of-year", "second", "second-of-minute", "week", "week-of-year", "year", "year-of-era" ]
- }, {
- "type" : "null"
- } ]
- },
- "lib/type" : {
- "default" : "metadata/column",
- "const" : "metadata/column"
- },
- "lib/source-uuid" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- }, {
- "type" : "null"
- } ]
- },
- "qp/implicit-field?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/ref-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/deduplicated-name" : {
- "description" : "The simply-deduplicated name that was historically used in QP results metadata (originally calculated by\n the [[metabase.query-processor.middleware.annotate]] middleware, now calculated\n by [[metabase.lib.middleware.result-metadata]]). This just adds suffixes to column names e.g. `ID` and `ID` become\n `ID` and `ID_2`, respectively. Kept around because many old field refs use this column name.",
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/transformation-added-base-type" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-expression-name" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "lib/from-model?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/card-id" : {
- "oneOf" : [ {
- "description" : "Valid Card ID",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "lib/expression-name" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "lib/breakout?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-effective-type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/join-alias" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "qp/native-sandbox-column.propagate-coercion?" : {
- "type" : "boolean"
- },
- "lib/internal-remap" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-binning" : {
- "oneOf" : [ {
- "description" : "Schema for `:binning` options passed to a `:field` clause.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
- },
- "strategy" : {
- "const" : "bin-width"
- }
- },
- "required" : [ "strategy", "bin-width" ]
- }, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
- },
- "strategy" : {
- "const" : "num-bins"
- }
- },
- "required" : [ "strategy", "num-bins" ]
- } ]
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-join-alias" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "qp/native-sandbox-column.force-coercion-strategy" : {
- "type" : "string"
- },
- "lib/binning" : {
- "oneOf" : [ {
- "description" : "Schema for `:binning` options passed to a `:field` clause.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "strategy" : {
- "const" : "default"
- }
- },
- "required" : [ "strategy" ]
- }, {
- "type" : "object",
- "properties" : {
- "bin-width" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
- },
- "strategy" : {
- "const" : "bin-width"
- }
- },
- "required" : [ "strategy", "bin-width" ]
- }, {
- "type" : "object",
- "properties" : {
- "num-bins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
- },
- "strategy" : {
- "const" : "num-bins"
- }
- },
- "required" : [ "strategy", "num-bins" ]
- } ]
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "metabase.lib.metadata.result-metadata/source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
- }, {
- "type" : "null"
- } ]
- },
- "lib/source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
- }, {
- "type" : "null"
- } ]
- },
- "lib/ref-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-name" : {
- "description" : "The original name of the column as it appeared in the very first place it came from (i.e., the physical name of the\n column in the table it appears in). This should be the same as the `:lib/source-column-alias` for the very first\n usage of the column.\n Allowed to be blank because some databases like SQL Server allow blank column names.",
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/simple-display-name" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "lib/desired-column-alias" : {
- "oneOf" : [ {
- "description" : "Name we should use as a column alias for a column in this stage of a query. The desired column alias in stage N\n becomes the source column alias in stage N+1. The right-hand side (RHS) in\n\n SELECT lhs AS rhs",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }
- },
- "metabase.legacy-mbql.schema.Addable" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpressionArg"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DateTimeExpressionArg"
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.interval"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.segment"
- } ]
- } ]
- },
- "metabase.legacy-mbql.schema.Aggregation" : {
- "description" : "Schema for anything that is a valid `:aggregation` clause.",
- "allOf" : [ {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation-options"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.UnnamedAggregation"
- } ]
- }, {
- "description" : "Normalization should automatically unwrap :aggregation-options with an empty options map"
- } ]
- },
- "metabase.legacy-mbql.schema.AggregationOptionsOptions" : {
- "description" : "Additional options for any aggregation clause when wrapping it in `:aggregation-options`.",
- "type" : "object",
- "properties" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }
- }
- },
- "metabase.legacy-mbql.schema.AggregationRefOptions" : {
- "type" : "object",
- "properties" : {
- "base-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }
- }
- },
- "metabase.legacy-mbql.schema.Aggregations" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
- },
- "minItems" : 1
- },
- "metabase.legacy-mbql.schema.AnyMBQLClause" : {
- "description" : "Schema for ANY valid MBQL clause"
- },
- "metabase.legacy-mbql.schema.ArithmeticDateTimeUnit" : {
- "type" : "string",
- "enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year" ]
- },
- "metabase.legacy-mbql.schema.BooleanExpression" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.and"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.or"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._EQ_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._BANG__EQ_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT__EQ_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT__EQ_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.between"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.starts-with"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ends-with"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.contains"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.in"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not-in"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.does-not-contain"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.inside"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.is-empty"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not-empty"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.is-null"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not-null"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.relative-time-interval"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.time-interval"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.during"
- } ]
- },
- "metabase.legacy-mbql.schema.Breakouts" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- },
- "minItems" : 1
- },
- "metabase.legacy-mbql.schema.CaseOptions" : {
- "type" : "object",
- "properties" : {
- "default" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
- }
- }
- },
- "metabase.legacy-mbql.schema.CaseSubclause" : {
- "type" : "array",
- "prefixItems" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Filter"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
- } ]
- },
- "metabase.legacy-mbql.schema.CaseSubclauses" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.CaseSubclause"
- },
- "minItems" : 1
- },
- "metabase.legacy-mbql.schema.CheckKeysForQueryType" : {
- "allOf" : [ ]
- },
- "metabase.legacy-mbql.schema.CheckQueryDoesNotHaveSourceMetadata" : {
- "description" : "`:source-metadata` is added to queries when `card__id` source queries are resolved. It contains info about the\n columns in the source query.\n\n Where this is added was changed in Metabase 0.33.0 -- previously, when `card__id` source queries were resolved, the\n middleware would add `:source-metadata` to the top-level; to support joins against source queries, this has been\n changed so it is always added at the same level the resolved `:source-query` is added.\n\n This should automatically be fixed by `normalize`; if we encounter it, it means some middleware is not functioning\n properly."
- },
- "metabase.legacy-mbql.schema.DatabaseID" : {
- "description" : "Schema for a valid `:database` ID, in the top-level 'outer' query. Either a positive integer (referring to an\n actual Database), or the saved questions virtual ID, which is a placeholder used for queries using the\n `:source-table \"card__id\"` shorthand for a source query resolved by middleware (since clients might not know the\n actual DB for that source query.)",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- } ]
- },
- "metabase.legacy-mbql.schema.DateOrDatetimeLiteral" : {
- "description" : "Schema for a valid date or datetime literal.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.relative-datetime"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.absolute-datetime"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.datetime"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.date"
- } ]
- },
- "metabase.legacy-mbql.schema.DateTimeExpressionArg" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeExpression"
- }, {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DateOrDatetimeLiteral"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- } ]
- } ]
- },
- "metabase.legacy-mbql.schema.DateTimeUnit" : {
- "description" : "Valid unit for *datetime* bucketing.",
- "type" : "string",
- "enum" : [ "quarter", "day", "hour", "week", "second", "default", "day-of-week", "hour-of-day", "month", "month-of-year", "day-of-month", "year", "day-of-year", "millisecond", "year-of-era", "week-of-year", "quarter-of-year", "minute-of-hour", "minute" ]
- },
- "metabase.legacy-mbql.schema.DateUnit" : {
- "description" : "Valid unit for date bucketing.",
- "type" : "string",
- "enum" : [ "quarter", "day", "week", "default", "day-of-week", "month", "month-of-year", "day-of-month", "year", "day-of-year", "year-of-era", "week-of-year", "quarter-of-year" ]
- },
- "metabase.legacy-mbql.schema.DatetimeDiffUnit" : {
- "description" : "Valid units for a datetime-diff clause.",
- "type" : "string",
- "enum" : [ "second", "minute", "hour", "day", "week", "month", "quarter", "year" ]
- },
- "metabase.legacy-mbql.schema.DatetimeExpression" : {
- "description" : "Schema for the definition of a date function expression.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._PLUS_"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime-add"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime-subtract"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.convert-timezone"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.now"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.date"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.today"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.coalesce"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.case"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.if"
- } ]
- },
- "metabase.legacy-mbql.schema.DatetimeOptions" : {
- "type" : "object",
- "properties" : {
- "mode" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeOptionsMode"
- }
- }
- },
- "metabase.legacy-mbql.schema.DatetimeOptionsMode" : {
- "type" : "string",
- "enum" : [ "simple-bytes", "unix-nanoseconds", "simple", "iso", "iso-bytes", "unix-seconds", "unix-milliseconds", "unix-microseconds" ]
- },
- "metabase.legacy-mbql.schema.Emptyable" : {
- "description" : "Schema for a valid is-empty or not-empty argument.",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.StringExpressionArg"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- } ]
- },
- "metabase.legacy-mbql.schema.EqualityComparable" : {
- "description" : "Schema for things that make sense in a `=` or `!=` filter, i.e. things that can be compared for equality.",
- "oneOf" : [ {
- "anyOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "number"
- }, {
- "type" : "string"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.TemporalLiteral"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRefOrRelativeDatetime"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.ExpressionArg"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "metabase.legacy-mbql.schema.EqualityFilterFieldArg" : {
- "description" : "Schema for the first arg to `=`, `!=`, and friends.",
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.EqualityComparable"
- },
- "metabase.legacy-mbql.schema.ExpressionArg" : {
- "oneOf" : [ {
- "type" : "number"
- }, {
- "type" : "boolean"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.BooleanExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.DatetimeExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Aggregation"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.aggregation"
- }, {
- "type" : "string"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.StringExpression"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.value"
- }, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.FieldOrExpressionRef"
- } ]
- },
- "metabase.legacy-mbql.schema.ExpressionName" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "metabase.legacy-mbql.schema.ExpressionRefOptions" : {
- "description" : "Options for a legacy `:expression` ref in MBQL 4 are the same as in MBQL 5, except that `:lib/uuid` is optional and\n it cannot be empty.",
- "default" : { },
- "type" : "object",
- "properties" : {
- "base-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "database-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "lib/uuid" : {
- "type" : "string",
- "minLength" : 36,
- "maxLength" : 36
- },
- "name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "semantic-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
- },
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }
- }
+ }
},
"metabase.legacy-mbql.schema.Expressions" : {
"type" : "object",
@@ -10451,191 +7993,641 @@
"items" : {
"$ref" : "#/components/schemas/metabase.lib.schema.breakout"
},
- "minItems" : 1
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
- } ]
- },
- "metabase.lib.schema.common.base-type" : {
- "type" : "string"
- },
- "metabase.lib.schema.common.kebab-cased-map" : { },
- "metabase.lib.schema.common.non-blank-string" : {
- "type" : "string",
- "minLength" : 1
- },
- "metabase.lib.schema.common.options" : {
- "default" : { },
- "type" : "object",
- "properties" : {
- "base-type" : {
+ "minItems" : 1
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
+ } ]
+ },
+ "metabase.lib.schema.common.base-type" : {
+ "type" : "string"
+ },
+ "metabase.lib.schema.common.kebab-cased-map" : { },
+ "metabase.lib.schema.common.non-blank-string" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "metabase.lib.schema.common.options" : {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "lib/uuid" ]
+ },
+ "metabase.lib.schema.common.positive-number" : { },
+ "metabase.lib.schema.common.semantic-or-relation-type" : {
+ "description" : "valid semantic or relation type",
+ "type" : "string"
+ },
+ "metabase.lib.schema.common.uuid" : {
+ "type" : "string",
+ "minLength" : 36,
+ "maxLength" : 36
+ },
+ "metabase.lib.schema.constraints.constraints" : {
+ "description" : "Additional constraints added to a query limiting the maximum number of rows that can be returned. Mostly useful\n because native queries don't support the MBQL `:limit` clause. For MBQL queries, if `:limit` is set, it will\n override these values.",
+ "type" : "object",
+ "properties" : {
+ "max-results" : {
+ "description" : "Maximum number of results to allow for a query with aggregations. If `max-results-bare-rows` is unset, this\n applies to all queries",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "max-results-bare-rows" : {
+ "description" : "Maximum number of results to allow for a query with no aggregations. If set, this should be LOWER than\n `:max-results`.",
+ "type" : "integer",
+ "minimum" : 0
+ }
+ }
+ },
+ "metabase.lib.schema.deduplicate-refs-ignoring-source-field-name-when-possible" : { },
+ "metabase.lib.schema.expression..expression.definition" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
+ },
+ "metabase.lib.schema.expression.arithmetic..args.numbers" : { },
+ "metabase.lib.schema.expression.arithmetic.plus-minus-numeric-schema" : { },
+ "metabase.lib.schema.expression.arithmetic.plus-minus-temporal-interval-schema" : {
+ "allOf" : [ ]
+ },
+ "metabase.lib.schema.expression.arithmetic.temporal-difference-schema" : { },
+ "metabase.lib.schema.expression.boolean" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
+ },
+ "metabase.lib.schema.expression.equality-comparable" : {
+ "oneOf" : [ {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.lib.schema.expression.expression" : {
+ "oneOf" : [ {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.lib.schema.expression.expressions" : {
+ "description" : "The `:expressions` definition map as found as a top-level key in an MBQL stage.",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression..expression.definition"
+ },
+ "minItems" : 1
+ },
+ "metabase.lib.schema.expression.integer" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
+ },
+ "metabase.lib.schema.expression.number" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
+ },
+ "metabase.lib.schema.expression.orderable" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
+ },
+ "metabase.lib.schema.expression.positive-integer-or-numeric-expression" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.integer"
+ },
+ "metabase.lib.schema.expression.string" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
+ },
+ "metabase.lib.schema.expression.temporal" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ } ]
+ },
+ "metabase.lib.schema.expression.temporal..absolute-datetime.base-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "metabase.lib.schema.expression.temporal..absolute-datetime.options" : {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "base-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "database-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "lib/uuid" ]
+ },
+ "metabase.lib.schema.expression.temporal..relative-datetime.amount" : {
+ "oneOf" : [ {
+ "const" : "current"
+ }, {
+ "type" : "integer"
+ } ]
+ },
+ "metabase.lib.schema.expression.temporal..relative-datetime.unit" : {
+ "anyOf" : [ {
+ "const" : "default"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
+ } ]
+ },
+ "metabase.lib.schema.expression.temporal..temporal-extract.unit" : {
+ "type" : "string",
+ "enum" : [ "year-of-era", "quarter-of-year", "month-of-year", "week-of-year-iso", "week-of-year-us", "week-of-year-instance", "day-of-month", "day-of-week", "day-of-week-iso", "hour-of-day", "minute-of-hour", "second-of-minute" ]
+ },
+ "metabase.lib.schema.expression.temporal.datetime-diff-unit" : {
+ "type" : "string",
+ "enum" : [ "day", "week", "month", "quarter", "year", "second", "minute", "hour" ]
+ },
+ "metabase.lib.schema.expression.temporal.timezone-id" : {
+ "allOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.zone-offset"
+ } ]
+ } ]
+ },
+ "metabase.lib.schema.expression.temporal.week-mode" : {
+ "type" : "string",
+ "enum" : [ "iso", "us", "instance" ]
+ },
+ "metabase.lib.schema.expression.window..offset.n" : {
+ "type" : "integer"
+ },
+ "metabase.lib.schema.fields" : {
+ "allOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.ref.ref"
+ },
+ "minItems" : 1
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.deduplicate-refs-ignoring-source-field-name-when-possible"
+ } ]
+ },
+ "metabase.lib.schema.filter.string-filter-options" : {
+ "description" : "String filter operator options. Only set for `:contains`, `:does-not-contain`, `:starts-with`, `:ends-with`\n operators.",
+ "type" : "object",
+ "properties" : {
+ "case-sensitive" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "metabase.lib.schema.filter.time-interval-options" : {
+ "description" : "Options for `:time-interval` operator. Note that `:relative-time-interval` does not support these options.",
+ "type" : "object",
+ "properties" : {
+ "include-current" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "metabase.lib.schema.filters" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
+ },
+ "minItems" : 1
+ },
+ "metabase.lib.schema.id.action" : {
+ "description" : "Valid Action ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.card" : {
+ "description" : "Valid Card ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.collection" : {
+ "description" : "Valid Collection ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.dashboard" : {
+ "description" : "Valid Dashboard ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.dashcard" : {
+ "description" : "Valid DashboardCard ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.database" : {
+ "description" : "Valid Database ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.dimension" : {
+ "description" : "Valid Dimension ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.field" : {
+ "description" : "Valid Field ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.measure" : {
+ "description" : "Valid Measure ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.pulse" : {
+ "description" : "Valid Pulse ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.sandbox" : {
+ "description" : "Valid Sandbox ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.saved-questions-virtual-database" : {
+ "description" : "The ID used to signify that a database is 'virtual' rather than physical.\n\n A fake integer ID is used so as to minimize the number of changes that need to be made on the frontend -- by using\n something that would otherwise be a legal ID, *nothing* need change there, and the frontend can query against this\n 'database' none the wiser. (This integer ID is negative which means it will never conflict with a *real* database\n ID.)\n\n This ID acts as a sort of flag. The relevant places in the middleware can check whether the DB we're querying is\n this 'virtual' database and take the appropriate actions.",
+ "const" : -1337
+ },
+ "metabase.lib.schema.id.segment" : {
+ "description" : "Valid legacy Segment ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.snippet" : {
+ "description" : "Valid Snippet ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.table" : {
+ "description" : "Valid Table ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.transform" : {
+ "description" : "Valid Transform ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.id.user" : {
+ "description" : "Valid User ID",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase.lib.schema.info.context" : {
+ "description" : "Schema for `info.context`; used for informational purposes to record how a query was executed.",
+ "type" : "string",
+ "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "transform-inspector", "slackbot" ]
+ },
+ "metabase.lib.schema.info.hash" : {
+ "type" : "string",
+ "format" : "byte"
+ },
+ "metabase.lib.schema.info.info" : {
+ "description" : "Schema for query `:info` dictionary, which is used for informational purposes to record information about how a query\n was executed in QueryExecution and other places. It is considered bad form for middleware to change its behavior\n based on this information, don't do it!\n\n TODO - this schema is somewhat misleading because if you use a function\n like [[metabase.query-processor/userland-query]] some of these keys (e.g. `:context`) are in fact required",
+ "type" : "object",
+ "properties" : {
+ "query-hash" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.info.hash"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "action-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.action"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lens-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "pivot/original-query" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "executed-by" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "card-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "pivot/result-metadata" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "oneOf" : [ {
+ "const" : "none"
+ }, {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ }
+ } ]
}, {
"type" : "null"
} ]
},
- "database-type" : {
+ "transform-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "context" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.info.context"
}, {
"type" : "null"
} ]
},
- "effective-type" : {
+ "dashboard-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
}, {
"type" : "null"
} ]
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "lens-params" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
+ "metadata/model-metadata" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
+ }
}, {
"type" : "null"
} ]
},
- "semantic-type" : {
+ "pulse-id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.pulse"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "lib/uuid" ]
- },
- "metabase.lib.schema.common.positive-number" : { },
- "metabase.lib.schema.common.semantic-or-relation-type" : {
- "description" : "valid semantic or relation type",
- "type" : "string"
- },
- "metabase.lib.schema.common.uuid" : {
- "type" : "string",
- "minLength" : 36,
- "maxLength" : 36
- },
- "metabase.lib.schema.constraints.constraints" : {
- "description" : "Additional constraints added to a query limiting the maximum number of rows that can be returned. Mostly useful\n because native queries don't support the MBQL `:limit` clause. For MBQL queries, if `:limit` is set, it will\n override these values.",
- "type" : "object",
- "properties" : {
- "max-results" : {
- "description" : "Maximum number of results to allow for a query with aggregations. If `max-results-bare-rows` is unset, this\n applies to all queries",
- "type" : "integer",
- "minimum" : 0
},
- "max-results-bare-rows" : {
- "description" : "Maximum number of results to allow for a query with no aggregations. If set, this should be LOWER than\n `:max-results`.",
- "type" : "integer",
- "minimum" : 0
+ "card-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
}
}
},
- "metabase.lib.schema.deduplicate-refs-ignoring-source-field-name-when-possible" : { },
- "metabase.lib.schema.expression..expression.definition" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expression"
+ "metabase.lib.schema.join.alias" : {
+ "description" : "The name used to alias the joined table or query. This is usually generated automatically and generally looks like\n `table__via__field`. You can specify this yourself if you need to reference a joined field with a `:join-alias` in\n the options.",
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "metabase.lib.schema.expression.arithmetic..args.numbers" : { },
- "metabase.lib.schema.expression.arithmetic.plus-minus-numeric-schema" : { },
- "metabase.lib.schema.expression.arithmetic.plus-minus-temporal-interval-schema" : {
- "allOf" : [ ]
+ "metabase.lib.schema.join.condition" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
},
- "metabase.lib.schema.expression.arithmetic.temporal-difference-schema" : { },
- "metabase.lib.schema.expression.boolean" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- } ]
+ "metabase.lib.schema.join.conditions" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.condition"
+ },
+ "minItems" : 1
},
- "metabase.lib.schema.expression.equality-comparable" : {
+ "metabase.lib.schema.join.fields" : {
+ "description" : "The Fields to include in the results *if* a top-level `:fields` clause *is not* specified. This can be either\n `:none`, `:all`, or a sequence of Field clauses.\n\n * `:none`: no Fields from the joined table or nested query are included (unless indirectly included by breakouts or\n other clauses). This is the default, and what is used for automatically-generated joins.\n\n * `:all`: will include all of the Fields from the joined table or query\n\n * a sequence of Field clauses: include only the Fields specified. Only `:field` clauses are allowed here! References\n to expressions or aggregations in the thing we're joining should use column literal (string column name) `:field`\n references. This should be non-empty and all elements should be distinct (ignoring `:lib/uuid`).",
"oneOf" : [ {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ "type" : "string",
+ "enum" : [ "all", "none" ]
+ }, {
+ "allOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/mbql.clause.field"
+ },
+ "minItems" : 1
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
} ]
- }, {
- "type" : "null"
} ]
},
- "metabase.lib.schema.expression.expression" : {
- "oneOf" : [ {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- } ]
+ "metabase.lib.schema.join.join" : {
+ "allOf" : [ {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ },
+ "conditions" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.conditions"
+ },
+ "fields" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.fields"
+ },
+ "lib/type" : {
+ "default" : "mbql/join",
+ "const" : "mbql/join"
+ },
+ "stages" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.stages"
+ },
+ "strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.strategy"
+ }
+ },
+ "required" : [ "lib/type", "stages", "conditions", "alias" ]
}, {
- "type" : "null"
+ "allOf" : [ ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.validate-field-aliases-match-join-alias"
} ]
},
- "metabase.lib.schema.expression.expressions" : {
- "description" : "The `:expressions` definition map as found as a top-level key in an MBQL stage.",
+ "metabase.lib.schema.join.joins" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression..expression.definition"
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.join"
},
"minItems" : 1
},
- "metabase.lib.schema.expression.integer" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- } ]
+ "metabase.lib.schema.join.strategy" : {
+ "description" : "Valid values for the optional `:strategy` key in a join. Note that these are only valid if the current Database\n supports that specific join type; these match 1:1 with the Database `:features`, e.g. a Database that supports left\n joins will support the `:left-join` feature.\n\n When `:strategy` is not specified, [[default-strategy]] is used.",
+ "default" : "left-join",
+ "type" : "string",
+ "enum" : [ "left-join", "right-join", "inner-join", "full-join" ]
},
- "metabase.lib.schema.expression.number" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- } ]
+ "metabase.lib.schema.join.validate-field-aliases-match-join-alias" : { },
+ "metabase.lib.schema.literal..string.date" : {
+ "type" : "string",
+ "pattern" : "^\\d{4}-\\d{2}-\\d{2}$"
},
- "metabase.lib.schema.expression.orderable" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ "metabase.lib.schema.literal..string.datetime" : {
+ "anyOf" : [ {
+ "type" : "string",
+ "pattern" : "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ "type" : "string",
+ "pattern" : "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))$"
} ]
},
- "metabase.lib.schema.expression.positive-integer-or-numeric-expression" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.integer"
- },
- "metabase.lib.schema.expression.string" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ "metabase.lib.schema.literal..string.time" : {
+ "anyOf" : [ {
+ "type" : "string",
+ "pattern" : "^\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
+ "type" : "string",
+ "pattern" : "^\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))$"
} ]
},
- "metabase.lib.schema.expression.temporal" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
- } ]
+ "metabase.lib.schema.literal..string.year" : {
+ "type" : "string",
+ "pattern" : "^\\d{4}$"
},
- "metabase.lib.schema.expression.temporal..absolute-datetime.base-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "metabase.lib.schema.literal..string.year-month" : {
+ "type" : "string",
+ "pattern" : "^\\d{4}-\\d{2}$"
},
- "metabase.lib.schema.expression.temporal..absolute-datetime.options" : {
+ "metabase.lib.schema.literal..string.zone-offset" : {
+ "type" : "string",
+ "pattern" : "(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))"
+ },
+ "metabase.lib.schema.literal..value.options" : {
"default" : { },
"type" : "object",
"properties" : {
"base-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
},
"database-type" : {
"oneOf" : [ {
@@ -10652,11 +8644,7 @@
} ]
},
"effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
},
"lib/uuid" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
@@ -10674,2751 +8662,4499 @@
}, {
"type" : "null"
} ]
+ },
+ "unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "lib/uuid" ]
+ "required" : [ "lib/uuid", "effective-type" ]
},
- "metabase.lib.schema.expression.temporal..relative-datetime.amount" : {
- "oneOf" : [ {
- "const" : "current"
+ "metabase.lib.schema.literal.date" : {
+ "anyOf" : [ { }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.date"
+ } ]
+ },
+ "metabase.lib.schema.literal.datetime" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
+ }, { }, { }, { } ]
+ },
+ "metabase.lib.schema.literal.integer" : {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, { } ]
+ },
+ "metabase.lib.schema.literal.jvm.big-decimal" : { },
+ "metabase.lib.schema.literal.jvm.float" : { },
+ "metabase.lib.schema.literal.literal" : {
+ "anyOf" : [ {
+ "type" : "null"
+ }, {
+ "type" : "boolean"
+ }, {
+ "type" : "string"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.integer"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.non-integer-real"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.temporal"
+ } ]
+ },
+ "metabase.lib.schema.literal.non-integer-real" : {
+ "anyOf" : [ {
+ "type" : "number"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.jvm.float"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.jvm.big-decimal"
+ } ]
+ },
+ "metabase.lib.schema.literal.temporal" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.date"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.time"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.datetime"
+ } ]
+ },
+ "metabase.lib.schema.literal.time" : {
+ "description" : "time literal",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.time"
+ }, { }, { } ]
+ },
+ "metabase.lib.schema.mbql-clause.clause" : {
+ "oneOf" : [ { }, {
+ "$ref" : "#/components/schemas/mbql.clause._BANG__EQ_"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause._STAR_"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause._PLUS_"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.-"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause._SLASH_"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause._LT_"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause._LT__EQ_"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause._EQ_"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause._GT_"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause._GT__EQ_"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.abs"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.absolute-datetime"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.aggregation"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.and"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.asc"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.avg"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.between"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.case"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.ceil"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.coalesce"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.collate"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.concat"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.contains"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.convert-timezone"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.count"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.count-where"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.cum-count"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.cum-sum"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.date"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.datetime"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.datetime-add"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.datetime-diff"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.datetime-subtract"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.day-name"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.desc"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.distinct"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.distinct-where"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.does-not-contain"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.domain"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.during"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.ends-with"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.exp"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.expression"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.field"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.float"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.floor"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.get-day"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.get-day-of-week"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.get-hour"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.get-minute"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.get-month"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.get-quarter"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.get-second"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.get-week"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.get-year"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.host"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.if"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.in"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.inside"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.integer"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.interval"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.is-empty"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.is-null"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.length"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.log"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.lower"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.ltrim"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.max"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.measure"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.median"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.metric"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.min"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.month-name"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.not"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.not-empty"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.not-in"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.not-null"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.now"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.offset"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.or"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.path"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.percentile"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.power"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.quarter-name"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.regex-match-first"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.relative-datetime"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.relative-time-interval"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.replace"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.round"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.rtrim"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.segment"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.share"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.split-part"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.sqrt"
}, {
- "type" : "integer"
- } ]
- },
- "metabase.lib.schema.expression.temporal..relative-datetime.unit" : {
- "anyOf" : [ {
- "const" : "default"
+ "$ref" : "#/components/schemas/mbql.clause.starts-with"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing..unit.date-time.interval"
+ "$ref" : "#/components/schemas/mbql.clause.stddev"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.subdomain"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.substring"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.sum"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.sum-where"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.temporal-extract"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.text"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.time"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.time-interval"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.today"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.trim"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.upper"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.value"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.var"
} ]
},
- "metabase.lib.schema.expression.temporal..temporal-extract.unit" : {
+ "metabase.lib.schema.metadata..card.type" : {
+ "description" : "All acceptable card types.\n\n Previously (< 49), we only had 2 card types: question and model, which were differentiated using the boolean\n `dataset` column. Soon we'll have more card types (e.g: metric) and we will longer be able to use a boolean column\n to differentiate between all types. So we've added a new `type` column for this purpose.\n\n Migrating all the code to use `report_card.type` will be quite an effort, we decided that we'll migrate it\n gradually.",
"type" : "string",
- "enum" : [ "year-of-era", "quarter-of-year", "month-of-year", "week-of-year-iso", "week-of-year-us", "week-of-year-instance", "day-of-month", "day-of-week", "day-of-week-iso", "hour-of-day", "minute-of-hour", "second-of-minute" ]
+ "enum" : [ "question", "metric", "model" ]
},
- "metabase.lib.schema.expression.temporal.datetime-diff-unit" : {
+ "metabase.lib.schema.metadata..column.has-field-values" : {
"type" : "string",
- "enum" : [ "day", "week", "month", "quarter", "year", "second", "minute", "hour" ]
- },
- "metabase.lib.schema.expression.temporal.timezone-id" : {
- "allOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.zone-offset"
- } ]
- } ]
+ "enum" : [ "auto-list", "list", "none", "search" ]
},
- "metabase.lib.schema.expression.temporal.week-mode" : {
+ "metabase.lib.schema.metadata..column.legacy-source" : {
+ "description" : "Possible values for `column.source` -- this is added by [[metabase.lib.metadata.result-metadata]] for historical\n reasons (it is used in a few places in the FE). DO NOT use this in the backend for any purpose, use `:lib/source`\n instead.",
"type" : "string",
- "enum" : [ "iso", "us", "instance" ]
- },
- "metabase.lib.schema.expression.window..offset.n" : {
- "type" : "integer"
- },
- "metabase.lib.schema.fields" : {
- "allOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.ref.ref"
- },
- "minItems" : 1
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.deduplicate-refs-ignoring-source-field-name-when-possible"
- } ]
+ "enum" : [ "aggregation", "fields", "breakout", "native" ]
},
- "metabase.lib.schema.filter.string-filter-options" : {
- "description" : "String filter operator options. Only set for `:contains`, `:does-not-contain`, `:starts-with`, `:ends-with`\n operators.",
+ "metabase.lib.schema.metadata..column.remapping.external" : {
+ "description" : "External remapping (Dimension) for a column. From the [[metabase.warehouse-schema.models.dimension]] with `type =\n external` associated with a `Field` in the application database.\n See [[metabase.query-processor.middleware.add-remaps]] for what this means.",
"type" : "object",
"properties" : {
- "case-sensitive" : {
- "type" : "boolean"
+ "field-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ },
+ "lib/type" : {
+ "const" : "metadata.column.remapping/external"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}
- }
+ },
+ "required" : [ "lib/type", "id", "name", "field-id" ]
},
- "metabase.lib.schema.filter.time-interval-options" : {
- "description" : "Options for `:time-interval` operator. Note that `:relative-time-interval` does not support these options.",
+ "metabase.lib.schema.metadata..column.remapping.internal" : {
+ "description" : "Internal remapping (FieldValues) for a column. From [[metabase.warehouse-schema.models.dimension]] with `type =\n internal` and the [[metabase.warehouse-schema.models.field-values]] associated with a `Field` in the application\n database. See [[metabase.query-processor.middleware.add-remaps]] for what this means.",
"type" : "object",
"properties" : {
- "include-current" : {
- "type" : "boolean"
+ "human-readable-values" : {
+ "type" : "array",
+ "items" : { }
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
+ },
+ "lib/type" : {
+ "const" : "metadata.column.remapping/internal"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "values" : {
+ "type" : "array",
+ "items" : { }
}
- }
- },
- "metabase.lib.schema.filters" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
},
- "minItems" : 1
- },
- "metabase.lib.schema.id.action" : {
- "description" : "Valid Action ID",
- "type" : "integer",
- "minimum" : 1
- },
- "metabase.lib.schema.id.card" : {
- "description" : "Valid Card ID",
- "type" : "integer",
- "minimum" : 1
- },
- "metabase.lib.schema.id.collection" : {
- "description" : "Valid Collection ID",
- "type" : "integer",
- "minimum" : 1
- },
- "metabase.lib.schema.id.dashboard" : {
- "description" : "Valid Dashboard ID",
- "type" : "integer",
- "minimum" : 1
- },
- "metabase.lib.schema.id.dashcard" : {
- "description" : "Valid DashboardCard ID",
- "type" : "integer",
- "minimum" : 1
+ "required" : [ "lib/type", "id", "name", "values", "human-readable-values" ]
},
- "metabase.lib.schema.id.database" : {
- "description" : "Valid Database ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.source" : {
+ "description" : "`:lib/source` -- where a column came from with respect to the current stage.\n\n Traditionally, `:lib/source` meant something slightly different -- it denoted what part of the current stage a\n column came from, and thus included two additional options -- `:source/fields`, for columns used by `:fields`, and\n `:source/breakouts`, for columns used in `:breakout`. This was not really useful information and made `:lib/source`\n itself useless for determining if a column was 'inherited' or not (i.e., whether it came from a previous stage,\n source card, or a join, and should get field name refs instead of field ID refs --\n see [[metabase.lib.field.util/inherited-column?]]).",
+ "type" : "string",
+ "enum" : [ "source/card", "source/native", "source/previous-stage", "source/table-defaults", "source/aggregations", "source/joins", "source/expressions", "source/implicitly-joinable" ]
},
- "metabase.lib.schema.id.dimension" : {
- "description" : "Valid Dimension ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.validate-for-source" : {
+ "description" : "Do additional validation for column metadata based on `:lib/source`.",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-card"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-native"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-previous-stage"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-table-defaults"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-aggregations"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-joins"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-expressions"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable"
+ }, { } ]
},
- "metabase.lib.schema.id.field" : {
- "description" : "Valid Field ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.validate-for-source-aggregations" : {
+ "allOf" : [ ]
},
- "metabase.lib.schema.id.measure" : {
- "description" : "Valid Measure ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.validate-for-source-card" : {
+ "allOf" : [ ]
},
- "metabase.lib.schema.id.pulse" : {
- "description" : "Valid Pulse ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.validate-for-source-expressions" : {
+ "allOf" : [ ]
},
- "metabase.lib.schema.id.sandbox" : {
- "description" : "Valid Sandbox ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable" : {
+ "allOf" : [ ]
},
- "metabase.lib.schema.id.saved-questions-virtual-database" : {
- "description" : "The ID used to signify that a database is 'virtual' rather than physical.\n\n A fake integer ID is used so as to minimize the number of changes that need to be made on the frontend -- by using\n something that would otherwise be a legal ID, *nothing* need change there, and the frontend can query against this\n 'database' none the wiser. (This integer ID is negative which means it will never conflict with a *real* database\n ID.)\n\n This ID acts as a sort of flag. The relevant places in the middleware can check whether the DB we're querying is\n this 'virtual' database and take the appropriate actions.",
- "const" : -1337
+ "metabase.lib.schema.metadata..column.validate-for-source-joins" : {
+ "allOf" : [ ]
},
- "metabase.lib.schema.id.segment" : {
- "description" : "Valid legacy Segment ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.validate-for-source-native" : {
+ "allOf" : [ ]
},
- "metabase.lib.schema.id.snippet" : {
- "description" : "Valid Snippet ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.validate-for-source-previous-stage" : {
+ "allOf" : [ ]
},
- "metabase.lib.schema.id.table" : {
- "description" : "Valid Table ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.validate-for-source-table-defaults" : {
+ "allOf" : [ ]
},
- "metabase.lib.schema.id.transform" : {
- "description" : "Valid Transform ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata..column.visibility-type" : {
+ "type" : "string",
+ "enum" : [ "retired", "sensitive", "normal", "hidden", "details-only" ]
},
- "metabase.lib.schema.id.user" : {
- "description" : "Valid User ID",
- "type" : "integer",
- "minimum" : 1
+ "metabase.lib.schema.metadata.column" : {
+ "description" : "Malli schema for a valid map of column metadata, which can mean one of two things:\n\n 1. Metadata about a particular Field in the application database. This will always have an `:id`\n\n 2. Results metadata from a column in `data.cols` and/or `data.results_metadata.columns` in a Query Processor\n response, or saved in something like `Card.result_metadata`. These *may* have an `:id`, or may not -- columns\n coming back from native queries or things like `SELECT count(*)` aren't associated with any particular `Field`\n and thus will not have an `:id`.\n\n Now maybe these should be two different schemas, but `:id` being there or not is the only real difference; besides\n that they are largely compatible. So they're the same for now. We can revisit this in the future if we actually want\n to differentiate between the two versions.",
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "visibility-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk-join-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/external-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "inherited-temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/source-column-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.source-column-alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/type" : {
+ "default" : "metadata/column",
+ "const" : "metadata/column"
+ },
+ "settings" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fingerprint" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/source-uuid" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "qp/implicit-field?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/ref-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/deduplicated-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.deduplicated-name"
+ },
+ "base-type" : {
+ "default" : "type/*",
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-expression-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk-field-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/from-model?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "lib/card-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/expression-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/breakout?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/join-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "nfc-path" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
+ },
+ "has-field-values" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/internal-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "selected?" : {
+ "type" : "boolean"
+ },
+ "fk-field-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-join-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "type" : "string"
+ },
+ "lib/binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.lib.metadata.result-metadata/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "active" : {
+ "type" : "boolean"
+ },
+ "lib/ref-display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk-target-field-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/simple-display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/desired-column-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "lib/type", "name", "base-type" ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
+ }, {
+ "allOf" : [ ]
+ } ]
},
- "metabase.lib.schema.info.context" : {
- "description" : "Schema for `info.context`; used for informational purposes to record how a query was executed.",
- "type" : "string",
- "enum" : [ "action", "ad-hoc", "agent", "cache-refresh", "collection", "map-tiles", "pulse", "dashboard-subscription", "dashboard", "question", "csv-download", "xlsx-download", "json-download", "public-dashboard", "public-question", "public-csv-download", "public-xlsx-download", "public-json-download", "embedded-dashboard", "embedded-question", "embedded-csv-download", "embedded-xlsx-download", "embedded-json-download", "table-grid", "transform-inspector", "slackbot" ]
+ "metabase.lib.schema.metadata.deduplicated-name" : {
+ "description" : "The simply-deduplicated name that was historically used in QP results metadata (originally calculated by\n the [[metabase.query-processor.middleware.annotate]] middleware, now calculated\n by [[metabase.lib.middleware.result-metadata]]). This just adds suffixes to column names e.g. `ID` and `ID` become\n `ID` and `ID_2`, respectively. Kept around because many old field refs use this column name.",
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.lib.schema.info.hash" : {
- "type" : "string",
- "format" : "byte"
+ "metabase.lib.schema.metadata.desired-column-alias" : {
+ "description" : "Name we should use as a column alias for a column in this stage of a query. The desired column alias in stage N\n becomes the source column alias in stage N+1. The right-hand side (RHS) in\n\n SELECT lhs AS rhs",
+ "type" : "string"
},
- "metabase.lib.schema.info.info" : {
- "description" : "Schema for query `:info` dictionary, which is used for informational purposes to record information about how a query\n was executed in QueryExecution and other places. It is considered bad form for middleware to change its behavior\n based on this information, don't do it!\n\n TODO - this schema is somewhat misleading because if you use a function\n like [[metabase.query-processor/userland-query]] some of these keys (e.g. `:context`) are in fact required",
+ "metabase.lib.schema.metadata.fingerprint..fingerprint.global" : {
+ "description" : "Fingerprint values that Fields of all types should have.",
"type" : "object",
"properties" : {
- "query-hash" : {
+ "distinct-count" : {
+ "type" : "integer"
+ },
+ "nil%" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.info.hash"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
- },
- "action-id" : {
+ }
+ }
+ },
+ "metabase.lib.schema.metadata.fingerprint..fingerprint.number" : {
+ "description" : "Schema for fingerprint information for Fields deriving from `:type/Number`.",
+ "type" : "object",
+ "properties" : {
+ "avg" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.action"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "lens-id" : {
+ "max" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "pivot/original-query" : {
+ "min" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "executed-by" : {
+ "q1" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "card-id" : {
+ "q3" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "pivot/result-metadata" : {
+ "sd" : {
"oneOf" : [ {
- "oneOf" : [ {
- "const" : "none"
- }, {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
- }
- } ]
+ "type" : "number"
}, {
"type" : "null"
} ]
- },
- "transform-id" : {
+ }
+ }
+ },
+ "metabase.lib.schema.metadata.fingerprint..fingerprint.temporal" : {
+ "description" : "Schema for fingerprint information for Fields deriving from `:type/Temporal`.",
+ "type" : "object",
+ "properties" : {
+ "earliest" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "context" : {
+ "latest" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.info.context"
+ "type" : "string"
}, {
"type" : "null"
} ]
- },
- "dashboard-id" : {
+ }
+ }
+ },
+ "metabase.lib.schema.metadata.fingerprint..fingerprint.text" : {
+ "description" : "Schema for fingerprint information for Fields deriving from `:type/Text`.",
+ "type" : "object",
+ "properties" : {
+ "average-length" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ "type" : "number"
}, {
"type" : "null"
} ]
},
- "lens-params" : {
+ "percent-email" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
- "metadata/model-metadata" : {
+ "percent-json" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
- }
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
- "pulse-id" : {
+ "percent-state" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.pulse"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
},
- "card-name" : {
+ "percent-url" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
}, {
"type" : "null"
} ]
}
}
},
- "metabase.lib.schema.join.alias" : {
- "description" : "The name used to alias the joined table or query. This is usually generated automatically and generally looks like\n `table__via__field`. You can specify this yourself if you need to reference a joined field with a `:join-alias` in\n the options.",
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "metabase.lib.schema.metadata.fingerprint..fingerprint.type-specific" : {
+ "description" : "Schema for type-specific fingerprint information.",
+ "allOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "object",
+ "properties" : {
+ "type/DateTime" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.temporal"
+ },
+ "type/Number" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.number"
+ },
+ "type/Text" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.text"
+ }
+ }
+ } ]
},
- "metabase.lib.schema.join.condition" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.boolean"
+ "metabase.lib.schema.metadata.fingerprint.fingerprint" : {
+ "description" : "Schema for a Field 'fingerprint' generated as part of the analysis stage. Used to power the 'classification'\n sub-stage of analysis. Stored as the `fingerprint` column of Field.",
+ "type" : "object",
+ "properties" : {
+ "experimental" : {
+ "type" : "object",
+ "additionalProperties" : { }
+ },
+ "global" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.global"
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.type-specific"
+ }
+ }
},
- "metabase.lib.schema.join.conditions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.condition"
- },
- "minItems" : 1
+ "metabase.lib.schema.metadata.fingerprint.percent" : {
+ "description" : "Schema for something represting a percentage. A floating-point value between (inclusive) 0 and 1.",
+ "type" : "number"
},
- "metabase.lib.schema.join.fields" : {
- "description" : "The Fields to include in the results *if* a top-level `:fields` clause *is not* specified. This can be either\n `:none`, `:all`, or a sequence of Field clauses.\n\n * `:none`: no Fields from the joined table or nested query are included (unless indirectly included by breakouts or\n other clauses). This is the default, and what is used for automatically-generated joins.\n\n * `:all`: will include all of the Fields from the joined table or query\n\n * a sequence of Field clauses: include only the Fields specified. Only `:field` clauses are allowed here! References\n to expressions or aggregations in the thing we're joining should use column literal (string column name) `:field`\n references. This should be non-empty and all elements should be distinct (ignoring `:lib/uuid`).",
+ "metabase.lib.schema.metadata.lib-or-legacy-column" : {
+ "description" : "Schema for the maps in card `:result-metadata` and similar. These can be either\n `:metabase.lib.schema.metadata/result-metadata` (i.e., kebab-cased) maps, or map snake_cased as returned by QP\n metadata, but they should NOT be a mixture of both -- if we mixed them somehow there is a bug in our code.",
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "all", "none" ]
- }, {
+ "description" : "Malli schema for a valid map of column metadata, which can mean one of two things:\n\n 1. Metadata about a particular Field in the application database. This will always have an `:id`\n\n 2. Results metadata from a column in `data.cols` and/or `data.results_metadata.columns` in a Query Processor\n response, or saved in something like `Card.result_metadata`. These *may* have an `:id`, or may not -- columns\n coming back from native queries or things like `SELECT count(*)` aren't associated with any particular `Field`\n and thus will not have an `:id`.\n\n Now maybe these should be two different schemas, but `:id` being there or not is the only real difference; besides\n that they are largely compatible. So they're the same for now. We can revisit this in the future if we actually want\n to differentiate between the two versions.",
"allOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/mbql.clause.field"
+ "type" : "object",
+ "properties" : {
+ "visibility-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk-join-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/external-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "inherited-temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/source-column-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.source-column-alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/type" : {
+ "default" : "metadata/column",
+ "const" : "metadata/column"
+ },
+ "settings" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fingerprint" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/source-uuid" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "qp/implicit-field?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/ref-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/deduplicated-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.deduplicated-name"
+ },
+ "base-type" : {
+ "default" : "type/*",
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-expression-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk-field-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/from-model?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "lib/card-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/expression-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/breakout?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/join-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "nfc-path" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "qp/native-sandbox-column.propagate-coercion?" : {
+ "type" : "boolean"
+ },
+ "has-field-values" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/internal-remap" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "selected?" : {
+ "type" : "boolean"
+ },
+ "fk-field-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-join-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "qp/native-sandbox-column.force-coercion-strategy" : {
+ "type" : "string"
+ },
+ "lib/binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.lib.metadata.result-metadata/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "active" : {
+ "type" : "boolean"
+ },
+ "lib/ref-display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk-target-field-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/simple-display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/desired-column-alias" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "minItems" : 1
+ "required" : [ "lib/type", "name", "base-type" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
+ }, {
+ "allOf" : [ ]
} ]
- } ]
- },
- "metabase.lib.schema.join.join" : {
- "allOf" : [ {
- "default" : { },
- "type" : "object",
- "properties" : {
- "alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "conditions" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.conditions"
- },
- "fields" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.fields"
- },
- "lib/type" : {
- "default" : "mbql/join",
- "const" : "mbql/join"
- },
- "stages" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.stages"
- },
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.strategy"
- }
- },
- "required" : [ "lib/type", "stages", "conditions", "alias" ]
}, {
- "allOf" : [ ]
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.validate-field-aliases-match-join-alias"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
} ]
},
- "metabase.lib.schema.join.joins" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.join"
- },
- "minItems" : 1
- },
- "metabase.lib.schema.join.strategy" : {
- "description" : "Valid values for the optional `:strategy` key in a join. Note that these are only valid if the current Database\n supports that specific join type; these match 1:1 with the Database `:features`, e.g. a Database that supports left\n joins will support the `:left-join` feature.\n\n When `:strategy` is not specified, [[default-strategy]] is used.",
- "default" : "left-join",
- "type" : "string",
- "enum" : [ "left-join", "right-join", "inner-join", "full-join" ]
- },
- "metabase.lib.schema.join.validate-field-aliases-match-join-alias" : { },
- "metabase.lib.schema.literal..string.date" : {
- "type" : "string",
- "pattern" : "^\\d{4}-\\d{2}-\\d{2}$"
- },
- "metabase.lib.schema.literal..string.datetime" : {
- "anyOf" : [ {
- "type" : "string",
- "pattern" : "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$"
- }, {
- "type" : "string",
- "pattern" : "^\\d{4}-\\d{2}-\\d{2}[T ]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))$"
- } ]
+ "metabase.lib.schema.metadata.metadata-provider" : {
+ "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol.",
+ "$ref" : "#/components/schemas/metabase.lib.metadata.protocols.metadata-provider"
},
- "metabase.lib.schema.literal..string.time" : {
- "anyOf" : [ {
- "type" : "string",
- "pattern" : "^\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?$"
+ "metabase.lib.schema.metadata.original-name" : {
+ "description" : "The original name of the column as it appeared in the very first place it came from (i.e., the physical name of the\n column in the table it appears in). This should be the same as the `:lib/source-column-alias` for the very first\n usage of the column.\n Allowed to be blank because some databases like SQL Server allow blank column names.",
+ "oneOf" : [ {
+ "type" : "string"
}, {
- "type" : "string",
- "pattern" : "^\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))$"
+ "type" : "null"
} ]
},
- "metabase.lib.schema.literal..string.year" : {
- "type" : "string",
- "pattern" : "^\\d{4}$"
- },
- "metabase.lib.schema.literal..string.year-month" : {
- "type" : "string",
- "pattern" : "^\\d{4}-\\d{2}$"
- },
- "metabase.lib.schema.literal..string.zone-offset" : {
- "type" : "string",
- "pattern" : "(?:Z|(?:[+-]\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d{1,6})?)?))"
+ "metabase.lib.schema.metadata.source-column-alias" : {
+ "description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
+ "type" : "string"
},
- "metabase.lib.schema.literal..value.options" : {
- "default" : { },
+ "metabase.lib.schema.metadata.stage" : {
+ "description" : "Metadata about the columns returned by a particular stage of a pMBQL query. For example a single-stage native query\n like\n\n {:database 1\n :lib/type :mbql/query\n :stages [{:lib/type :mbql.stage/mbql\n :native \"SELECT id, name FROM VENUES;\"}]}\n\n might have stage metadata like\n\n {:columns [{:name \"id\", :base-type :type/Integer}\n {:name \"name\", :base-type :type/Text}]}\n\n associated with the query's lone stage.\n\n At some point in the near future we will hopefully attach this metadata directly to each stage in a query, so a\n multi-stage query will have `:lib/stage-metadata` for each stage. The main goal is to facilitate things like\n returning lists of visible or filterable columns for a given stage of a query. This is TBD, see #28717 for a WIP\n implementation of this idea.\n\n This is the same format as the results metadata returned with QP results in `data.results_metadata`. The `:columns`\n portion of this (`data.results_metadata.columns`) is also saved as `Card.result_metadata` for Saved Questions.\n\n Note that queries currently actually come back with both `data.results_metadata` AND `data.cols`; it looks like the\n Frontend actually *merges* these together -- see `applyMetadataDiff` in\n `frontend/src/metabase/query_builder/selectors.js` -- but this is ridiculous. Let's try to merge anything missing in\n `results_metadata` into `cols` going forward so things don't need to be manually merged in the future.",
"type" : "object",
"properties" : {
- "base-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ }
},
- "database-type" : {
+ "lib/type" : {
+ "default" : "metadata/results",
+ "const" : "metadata/results"
+ }
+ },
+ "required" : [ "lib/type", "columns" ]
+ },
+ "metabase.lib.schema.middleware-options.middleware-options" : {
+ "description" : "Additional options that can be used to toggle middleware on or off.",
+ "type" : "object",
+ "properties" : {
+ "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" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "display-name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
+ "disable-max-results?" : {
+ "description" : "Disable applying a default limit on the query results. Handled in the `add-default-limit` middleware. If true,\n this will override the `:max-results` and `:max-results-bare-rows` values in `Constraints`.",
+ "type" : "boolean"
},
- "effective-type" : {
- "type" : "string"
+ "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"
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "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"
},
- "name" : {
+ "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" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "semantic-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "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"
},
- "unit" : {
+ "userland-query?" : {
+ "description" : "Userland queries are ones ran as a result of an API call, Pulse, or the like. Special handling is done in\n certain userland-only middleware for such queries -- results are returned in a slightly different format, and\n QueryExecution entries are normally saved, unless you pass `:no-save` as the option.",
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
- },
- "required" : [ "lib/uuid", "effective-type" ]
- },
- "metabase.lib.schema.literal.date" : {
- "anyOf" : [ { }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.date"
- } ]
- },
- "metabase.lib.schema.literal.datetime" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
- }, { }, { }, { } ]
- },
- "metabase.lib.schema.literal.integer" : {
- "anyOf" : [ {
- "type" : "integer"
- }, { } ]
- },
- "metabase.lib.schema.literal.jvm.big-decimal" : { },
- "metabase.lib.schema.literal.jvm.float" : { },
- "metabase.lib.schema.literal.literal" : {
- "anyOf" : [ {
- "type" : "null"
- }, {
- "type" : "boolean"
- }, {
- "type" : "string"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.integer"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.non-integer-real"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.temporal"
- } ]
- },
- "metabase.lib.schema.literal.non-integer-real" : {
- "anyOf" : [ {
- "type" : "number"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.jvm.float"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.jvm.big-decimal"
- } ]
- },
- "metabase.lib.schema.literal.temporal" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.date"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.time"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal.datetime"
- } ]
- },
- "metabase.lib.schema.literal.time" : {
- "description" : "time literal",
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.time"
- }, { }, { } ]
+ }
},
- "metabase.lib.schema.mbql-clause.clause" : {
- "oneOf" : [ { }, {
- "$ref" : "#/components/schemas/mbql.clause._BANG__EQ_"
- }, {
- "$ref" : "#/components/schemas/mbql.clause._STAR_"
- }, {
- "$ref" : "#/components/schemas/mbql.clause._PLUS_"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.-"
- }, {
- "$ref" : "#/components/schemas/mbql.clause._SLASH_"
- }, {
- "$ref" : "#/components/schemas/mbql.clause._LT_"
- }, {
- "$ref" : "#/components/schemas/mbql.clause._LT__EQ_"
- }, {
- "$ref" : "#/components/schemas/mbql.clause._EQ_"
- }, {
- "$ref" : "#/components/schemas/mbql.clause._GT_"
- }, {
- "$ref" : "#/components/schemas/mbql.clause._GT__EQ_"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.abs"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.absolute-datetime"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.aggregation"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.and"
- }, {
+ "metabase.lib.schema.order-by.order-by" : {
+ "oneOf" : [ {
"$ref" : "#/components/schemas/mbql.clause.asc"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.avg"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.between"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.case"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.ceil"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.coalesce"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.collate"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.concat"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.contains"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.convert-timezone"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.count"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.count-where"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.cum-count"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.cum-sum"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.date"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.datetime"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.datetime-add"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.datetime-diff"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.datetime-subtract"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.day-name"
}, {
"$ref" : "#/components/schemas/mbql.clause.desc"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.distinct"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.distinct-where"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.does-not-contain"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.domain"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.during"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.ends-with"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.exp"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.expression"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.field"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.float"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.floor"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.get-day"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.get-day-of-week"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.get-hour"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.get-minute"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.get-month"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.get-quarter"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.get-second"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.get-week"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.get-year"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.host"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.if"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.in"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.inside"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.integer"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.interval"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.is-empty"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.is-null"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.length"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.log"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.lower"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.ltrim"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.max"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.measure"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.median"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.metric"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.min"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.month-name"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.not"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.not-empty"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.not-in"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.not-null"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.now"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.offset"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.or"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.path"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.percentile"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.power"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.quarter-name"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.regex-match-first"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.relative-datetime"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.relative-time-interval"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.replace"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.round"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.rtrim"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.segment"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.share"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.split-part"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.sqrt"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.starts-with"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.stddev"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.subdomain"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.substring"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.sum"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.sum-where"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.temporal-extract"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.text"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.time"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.time-interval"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.today"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.trim"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.upper"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.value"
- }, {
- "$ref" : "#/components/schemas/mbql.clause.var"
} ]
},
- "metabase.lib.schema.metadata..card.type" : {
- "description" : "All acceptable card types.\n\n Previously (< 49), we only had 2 card types: question and model, which were differentiated using the boolean\n `dataset` column. Soon we'll have more card types (e.g: metric) and we will longer be able to use a boolean column\n to differentiate between all types. So we've added a new `type` column for this purpose.\n\n Migrating all the code to use `report_card.type` will be quite an effort, we decided that we'll migrate it\n gradually.",
- "type" : "string",
- "enum" : [ "question", "metric", "model" ]
- },
- "metabase.lib.schema.metadata..column.has-field-values" : {
- "type" : "string",
- "enum" : [ "auto-list", "list", "none", "search" ]
- },
- "metabase.lib.schema.metadata..column.legacy-source" : {
- "description" : "Possible values for `column.source` -- this is added by [[metabase.lib.metadata.result-metadata]] for historical\n reasons (it is used in a few places in the FE). DO NOT use this in the backend for any purpose, use `:lib/source`\n instead.",
- "type" : "string",
- "enum" : [ "aggregation", "fields", "breakout", "native" ]
- },
- "metabase.lib.schema.metadata..column.remapping.external" : {
- "description" : "External remapping (Dimension) for a column. From the [[metabase.warehouse-schema.models.dimension]] with `type =\n external` associated with a `Field` in the application database.\n See [[metabase.query-processor.middleware.add-remaps]] for what this means.",
- "type" : "object",
- "properties" : {
- "field-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
- },
- "lib/type" : {
- "const" : "metadata.column.remapping/external"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }
- },
- "required" : [ "lib/type", "id", "name", "field-id" ]
+ "metabase.lib.schema.order-by.order-bys" : {
+ "allOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.order-by.order-by"
+ },
+ "minItems" : 1
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
+ } ]
},
- "metabase.lib.schema.metadata..column.remapping.internal" : {
- "description" : "Internal remapping (FieldValues) for a column. From [[metabase.warehouse-schema.models.dimension]] with `type =\n internal` and the [[metabase.warehouse-schema.models.field-values]] associated with a `Field` in the application\n database. See [[metabase.query-processor.middleware.add-remaps]] for what this means.",
+ "metabase.lib.schema.page" : {
+ "description" : "`page` = page num, starting with 1. `items` = number of items per page.\n e.g.\n\n {:page 1, :items 10} = items 1-10\n {:page 2, :items 10} = items 11-20",
"type" : "object",
"properties" : {
- "human-readable-values" : {
- "type" : "array",
- "items" : { }
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dimension"
- },
- "lib/type" : {
- "const" : "metadata.column.remapping/internal"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
},
- "values" : {
- "type" : "array",
- "items" : { }
+ "page" : {
+ "type" : "integer",
+ "minimum" : 1
}
},
- "required" : [ "lib/type", "id", "name", "values", "human-readable-values" ]
+ "required" : [ "page", "items" ]
},
- "metabase.lib.schema.metadata..column.source" : {
- "description" : "`:lib/source` -- where a column came from with respect to the current stage.\n\n Traditionally, `:lib/source` meant something slightly different -- it denoted what part of the current stage a\n column came from, and thus included two additional options -- `:source/fields`, for columns used by `:fields`, and\n `:source/breakouts`, for columns used in `:breakout`. This was not really useful information and made `:lib/source`\n itself useless for determining if a column was 'inherited' or not (i.e., whether it came from a previous stage,\n source card, or a join, and should get field name refs instead of field ID refs --\n see [[metabase.lib.field.util/inherited-column?]]).",
- "type" : "string",
- "enum" : [ "source/card", "source/native", "source/previous-stage", "source/table-defaults", "source/aggregations", "source/joins", "source/expressions", "source/implicitly-joinable" ]
+ "metabase.lib.schema.parameter..dimension.options" : {
+ "type" : "object",
+ "properties" : {
+ "stage-number" : {
+ "type" : "integer"
+ }
+ }
},
- "metabase.lib.schema.metadata..column.validate-for-source" : {
- "description" : "Do additional validation for column metadata based on `:lib/source`.",
+ "metabase.lib.schema.parameter..dimension.target" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-card"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-native"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-previous-stage"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-table-defaults"
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-expression-ref"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-aggregations"
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.template-tag"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-joins"
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
+ } ]
+ },
+ "metabase.lib.schema.parameter..parameter.value" : { },
+ "metabase.lib.schema.parameter..target.legacy-expression-ref" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.expression"
+ },
+ "metabase.lib.schema.parameter..target.legacy-field-ref" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
+ },
+ "metabase.lib.schema.parameter..template-tag.tag-name" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "id" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-expressions"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ } ]
+ },
+ "metabase.lib.schema.parameter..variable.target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable"
- }, { } ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.template-tag"
+ } ]
},
- "metabase.lib.schema.metadata..column.validate-for-source-aggregations" : {
- "allOf" : [ ]
+ "metabase.lib.schema.parameter.dimension" : { },
+ "metabase.lib.schema.parameter.id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "metabase.lib.schema.metadata..column.validate-for-source-card" : {
- "allOf" : [ ]
+ "metabase.lib.schema.parameter.parameter" : {
+ "description" : "Schema for the *value* of a parameter (e.g. a Dashboard parameter or a native query template tag) as passed in as\n part of the `:parameters` list in a query.\n\n Note that this is different from the parameter declarations that are saved as part of Dashboards and Cards; for THAT\n schema refer to `:metabase.parameters.schema/parameter`.",
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "default" : { },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "required" : { },
+ "slug" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "target" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
+ },
+ "value" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ }
+ },
+ "required" : [ "type" ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
+ } ]
},
- "metabase.lib.schema.metadata..column.validate-for-source-expressions" : {
- "allOf" : [ ]
+ "metabase.lib.schema.parameter.parameters" : {
+ "description" : "Schema for a list of `:parameters` as passed in to a query.",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameter"
+ }
},
- "metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable" : {
- "allOf" : [ ]
+ "metabase.lib.schema.parameter.target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.dimension"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.variable"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.text-tag"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
+ } ]
},
- "metabase.lib.schema.metadata..column.validate-for-source-joins" : {
- "allOf" : [ ]
+ "metabase.lib.schema.parameter.template-tag" : {
+ "description" : "This is the reference like [:template-tag <whatever>], not the schema for native query template tags -- that lives\n in [[metabase.lib.schema.template-tag]].",
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "template-tag"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..template-tag.tag-name"
+ } ]
},
- "metabase.lib.schema.metadata..column.validate-for-source-native" : {
- "allOf" : [ ]
+ "metabase.lib.schema.parameter.text-tag" : {
+ "description" : "A :text-tag parameter :target applies to parameterized text cards in viz settings",
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "text-tag"
+ }, {
+ "type" : "string"
+ } ]
},
- "metabase.lib.schema.metadata..column.validate-for-source-previous-stage" : {
- "allOf" : [ ]
+ "metabase.lib.schema.parameter.type" : {
+ "description" : "Valid parameter :type",
+ "default" : "text",
+ "type" : "string",
+ "enum" : [ "number", "text", "date", "boolean", "date/single", "id", "category", "location/city", "location/state", "location/zip_code", "location/country", "date/range", "date/month-year", "date/quarter-year", "date/relative", "date/all-options", "temporal-unit", "number/!=", "number/<=", "number/=", "number/>=", "number/between", "string/!=", "string/=", "string/contains", "string/does-not-contain", "string/ends-with", "string/starts-with", "boolean/=" ]
},
- "metabase.lib.schema.metadata..column.validate-for-source-table-defaults" : {
- "allOf" : [ ]
+ "metabase.lib.schema.parameter.variable" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "variable"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..variable.target"
+ } ]
},
- "metabase.lib.schema.metadata..column.visibility-type" : {
+ "metabase.lib.schema.parameter.widget-type" : {
+ "description" : "The type of widget to display in the FE UI for the user to use to pick values for this parameter.",
"type" : "string",
- "enum" : [ "retired", "sensitive", "normal", "hidden", "details-only" ]
+ "enum" : [ "none", "number", "text", "date", "boolean", "date/single", "id", "category", "location/city", "location/state", "location/zip_code", "location/country", "date/range", "date/month-year", "date/quarter-year", "date/relative", "date/all-options", "temporal-unit", "number/!=", "number/<=", "number/=", "number/>=", "number/between", "string/!=", "string/=", "string/contains", "string/does-not-contain", "string/ends-with", "string/starts-with", "boolean/=" ]
},
- "metabase.lib.schema.metadata.column" : {
- "description" : "Malli schema for a valid map of column metadata, which can mean one of two things:\n\n 1. Metadata about a particular Field in the application database. This will always have an `:id`\n\n 2. Results metadata from a column in `data.cols` and/or `data.results_metadata.columns` in a Query Processor\n response, or saved in something like `Card.result_metadata`. These *may* have an `:id`, or may not -- columns\n coming back from native queries or things like `SELECT count(*)` aren't associated with any particular `Field`\n and thus will not have an `:id`.\n\n Now maybe these should be two different schemas, but `:id` being there or not is the only real difference; besides\n that they are largely compatible. So they're the same for now. We can revisit this in the future if we actually want\n to differentiate between the two versions.",
+ "metabase.lib.schema.query" : {
"allOf" : [ {
+ "description" : "Valid MBQL 5 query.",
"type" : "object",
"properties" : {
- "visibility-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
- }, {
- "type" : "null"
- } ]
- },
- "fk-join-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- }, {
- "type" : "null"
- } ]
- },
- "metabase.lib.metadata.result-metadata/field-ref" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
- }, {
- "type" : "null"
- } ]
- },
- "lib/external-remap" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
- }, {
- "type" : "null"
- } ]
- },
- "inherited-temporal-unit" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }, {
- "type" : "null"
- } ]
- },
- "lib/source-column-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.source-column-alias"
- }, {
- "type" : "null"
- } ]
- },
- "database-type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "lib/metadata" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.metadata-provider"
},
- "lib/temporal-unit" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }, {
- "type" : "null"
- } ]
+ "update-row" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
},
"lib/type" : {
- "default" : "metadata/column",
- "const" : "metadata/column"
+ "default" : "mbql/query",
+ "const" : "mbql/query"
},
"settings" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "fingerprint" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "$ref" : "#/components/schemas/metabase.lib.schema.settings.settings"
},
- "lib/source-uuid" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- }, {
- "type" : "null"
- } ]
+ "constraints" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.constraints.constraints"
},
- "qp/implicit-field?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "info" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.info.info"
},
- "lib/ref-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "middleware" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
},
- "id" : {
+ "database" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
}, {
- "type" : "null"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
} ]
},
- "effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
+ "stages" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.stages"
},
- "lib/deduplicated-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.deduplicated-name"
+ "parameters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
},
- "base-type" : {
- "default" : "type/*",
+ "create-row" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
+ }
+ },
+ "required" : [ "lib/type", "stages" ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.util.unique-uuids"
+ }, {
+ "allOf" : [ ]
+ } ]
+ },
+ "metabase.lib.schema.ref..expression.options" : {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "base-type" : {
+ "oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }
+ },
+ "required" : [ "lib/uuid" ]
+ },
+ "metabase.lib.schema.ref..field.id" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "field"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.ref..field.options"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ } ]
+ },
+ "metabase.lib.schema.ref..field.literal" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "field"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.ref..field.literal.options"
+ }, {
+ "type" : "string"
+ } ]
+ },
+ "metabase.lib.schema.ref..field.literal.options" : {
+ "allOf" : [ {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
},
- "lib/transformation-added-base-type" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-expression-name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "fk-field-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/from-model?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "lib/card-id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }, {
- "type" : "null"
- } ]
- },
- "lib/expression-name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/breakout?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "lib/join-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- }, {
- "type" : "null"
- } ]
- },
- "nfc-path" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }, {
- "type" : "null"
- } ]
- },
- "qp/native-sandbox-column.propagate-coercion?" : {
- "type" : "boolean"
- },
- "has-field-values" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
- }, {
- "type" : "null"
- } ]
- },
- "lib/internal-remap" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
- }, {
- "type" : "null"
- } ]
- },
- "selected?" : {
- "type" : "boolean"
- },
- "fk-field-id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-binning" : {
+ "inherited-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "database-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "lib/original-join-alias" : {
+ "display-name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "lib/original-display-name" : {
+ "source-field-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "effective-type" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "qp/native-sandbox-column.force-coercion-strategy" : {
+ "base-type" : {
"type" : "string"
},
- "lib/binning" : {
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "metabase.lib.metadata.result-metadata/source" : {
+ "lib/original-effective-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "source-field" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ },
+ "lib/original-binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "source-field-join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "semantic-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
},
- "lib/source" : {
+ "original-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }
+ },
+ "required" : [ "lib/uuid", "base-type" ]
+ }, {
+ "allOf" : [ ]
+ } ]
+ },
+ "metabase.lib.schema.ref..field.options" : {
+ "allOf" : [ {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "inherited-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "database-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "active" : {
- "type" : "boolean"
- },
- "lib/ref-display-name" : {
+ "display-name" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "lib/original-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
+ "source-field-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
- "semantic-type" : {
+ "effective-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "fk-target-field-id" : {
+ "base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
}, {
"type" : "null"
} ]
},
- "lib/simple-display-name" : {
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
}, {
"type" : "null"
} ]
},
- "lib/desired-column-alias" : {
+ "lib/original-effective-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "source-field" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ },
+ "lib/original-binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "source-field-join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "semantic-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
}, {
"type" : "null"
} ]
+ },
+ "original-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}
},
- "required" : [ "lib/type", "name", "base-type" ]
+ "required" : [ "lib/uuid" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
+ "allOf" : [ ]
+ } ]
+ },
+ "metabase.lib.schema.ref.aggregation-options" : {
+ "default" : { },
+ "type" : "object",
+ "properties" : {
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/source-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "lib/uuid" ]
+ },
+ "metabase.lib.schema.ref.ref" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ },
+ "metabase.lib.schema.settings.settings" : {
+ "description" : "Options that tweak the behavior of the query processor.",
+ "type" : "object",
+ "properties" : {
+ "include-sensitive-fields" : {
+ "description" : "Whether to include fields with visibility_type :sensitive when fetching query metadata.",
+ "type" : "boolean"
+ },
+ "report-timezone" : {
+ "description" : "The timezone the query should be ran in, overriding the default report timezone for the instance.",
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal.timezone-id"
+ }
+ }
+ },
+ "metabase.lib.schema.stage" : {
+ "default" : {
+ "lib/type" : "mbql.stage/mbql"
+ },
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "lib/type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema..stage.type"
+ }
+ },
+ "required" : [ "lib/type" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema..stage.native"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema..stage.mbql"
+ } ]
}, {
"allOf" : [ ]
} ]
},
- "metabase.lib.schema.metadata.deduplicated-name" : {
- "description" : "The simply-deduplicated name that was historically used in QP results metadata (originally calculated by\n the [[metabase.query-processor.middleware.annotate]] middleware, now calculated\n by [[metabase.lib.middleware.result-metadata]]). This just adds suffixes to column names e.g. `ID` and `ID` become\n `ID` and `ID_2`, respectively. Kept around because many old field refs use this column name.",
- "oneOf" : [ {
- "type" : "string"
+ "metabase.lib.schema.stages" : {
+ "allOf" : [ {
+ "default" : [ ],
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.stage"
+ },
+ "minItems" : 1
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema..stages.valid-refs"
+ } ]
+ },
+ "metabase.lib.schema.template-tag..field-filter.options" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "metabase.lib.schema.template-tag..raw-value.type" : {
+ "type" : "string",
+ "enum" : [ "date", "number", "boolean", "text" ]
+ },
+ "metabase.lib.schema.template-tag..template-tag-map.validate-names" : { },
+ "metabase.lib.schema.template-tag..value.common" : {
+ "type" : "object",
+ "properties" : {
+ "default" : { },
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ },
+ "required" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "name", "display-name" ]
+ },
+ "metabase.lib.schema.template-tag.common" : {
+ "type" : "object",
+ "properties" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ }
+ },
+ "required" : [ "name", "display-name" ]
+ },
+ "metabase.lib.schema.template-tag.disallow-dimension" : { },
+ "metabase.lib.schema.template-tag.field-filter" : {
+ "type" : "object",
+ "properties" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ },
+ "required" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "const" : "dimension"
+ },
+ "alias" : {
+ "type" : "string"
+ },
+ "options" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..field-filter.options"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dimension" : {
+ "$ref" : "#/components/schemas/mbql.clause.field"
+ },
+ "default" : { },
+ "widget-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.widget-type"
+ }
+ },
+ "required" : [ "name", "display-name", "type", "widget-type" ]
+ },
+ "metabase.lib.schema.template-tag.id" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "uuid"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ } ]
+ },
+ "metabase.lib.schema.template-tag.name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "metabase.lib.schema.template-tag.raw-value" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "default" : { },
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ },
+ "required" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..raw-value.type"
+ }
+ },
+ "required" : [ "name", "display-name", "type" ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ } ]
+ },
+ "metabase.lib.schema.template-tag.snippet" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ },
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ },
+ "snippet-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
+ },
+ "snippet-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "type" : {
+ "const" : "snippet"
+ }
+ },
+ "required" : [ "name", "display-name", "type", "snippet-name" ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ } ]
+ },
+ "metabase.lib.schema.template-tag.source-filter" : {
+ "description" : "Schema for a single source-filter applied to a table template tag.",
+ "type" : "object",
+ "properties" : {
+ "field-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "op" : {
+ "type" : "string",
+ "enum" : [ "<=", ">", ">=", "!=", "=", "<" ]
+ },
+ "value" : { }
+ },
+ "required" : [ "field-id", "op", "value" ]
+ },
+ "metabase.lib.schema.template-tag.source-query" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "card-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ },
+ "type" : {
+ "const" : "card"
+ }
+ },
+ "required" : [ "name", "display-name", "type", "card-id" ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ } ]
+ },
+ "metabase.lib.schema.template-tag.source-table" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "emit-alias" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ },
+ "source-filters" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-filter"
+ }
+ },
+ "table-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "type" : {
+ "const" : "table"
+ }
+ },
+ "required" : [ "name", "display-name", "type", "table-id" ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ } ]
+ },
+ "metabase.lib.schema.template-tag.template-tag" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.type"
+ }
+ },
+ "required" : [ "type" ]
+ }, {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.temporal-unit"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.field-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.snippet"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-query"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-table"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.raw-value"
+ } ]
+ } ]
+ },
+ "metabase.lib.schema.template-tag.template-tag-map" : {
+ "allOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tag"
+ }
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..template-tag-map.validate-names"
+ } ]
+ },
+ "metabase.lib.schema.template-tag.temporal-unit" : {
+ "type" : "object",
+ "properties" : {
+ "alias" : {
+ "type" : "string"
+ },
+ "dimension" : {
+ "$ref" : "#/components/schemas/mbql.clause.field"
+ },
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ },
+ "type" : {
+ "const" : "temporal-unit"
+ }
+ },
+ "required" : [ "name", "display-name", "type" ]
+ },
+ "metabase.lib.schema.template-tag.type" : {
+ "description" : "Schema for valid values of template tag `:type`.",
+ "type" : "string",
+ "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "boolean", "temporal-unit", "table" ]
+ },
+ "metabase.lib.schema.template-tag.widget-type" : {
+ "description" : "Schema for valid values of `:widget-type` for a `:metabase.lib.schema.template-tag/field-filter` template tag.",
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.widget-type"
+ },
+ "metabase.lib.schema.temporal-bucketing..unit.date" : {
+ "type" : "string",
+ "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "month", "month-of-year", "quarter", "quarter-of-year", "week", "week-of-year", "year", "year-of-era" ]
+ },
+ "metabase.lib.schema.temporal-bucketing..unit.date-time" : {
+ "type" : "string",
+ "enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year", "second-of-minute", "minute-of-hour", "hour-of-day", "day-of-week", "day-of-month", "day-of-year", "week-of-year", "month-of-year", "quarter-of-year", "year-of-era" ]
+ },
+ "metabase.lib.schema.temporal-bucketing..unit.date-time.interval" : {
+ "type" : "string",
+ "enum" : [ "day", "hour", "millisecond", "minute", "month", "quarter", "second", "week", "year" ]
+ },
+ "metabase.lib.schema.temporal-bucketing..unit.time.interval" : {
+ "type" : "string",
+ "enum" : [ "hour", "millisecond", "minute", "second" ]
+ },
+ "metabase.lib.schema.temporal-bucketing.unit" : {
+ "type" : "string",
+ "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "default", "hour", "hour-of-day", "millisecond", "minute", "minute-of-hour", "month", "month-of-year", "quarter", "quarter-of-year", "second", "second-of-minute", "week", "week-of-year", "year", "year-of-era" ]
+ },
+ "metabase.lib.schema.util.distinct-mbql-clauses" : { },
+ "metabase.lib.schema.util.unique-uuids" : { },
+ "metabase.lib.schema.validate.source-entity-type" : {
+ "description" : "The type of the source entity causing an error.",
+ "type" : "string",
+ "enum" : [ "table", "card" ]
+ },
+ "metabase.lib.schema.validate.validate-error-type" : {
+ "type" : "string",
+ "enum" : [ "missing-column", "missing-table-alias", "duplicate-column", "syntax-error", "validation-exception-error" ]
+ },
+ "metabase.logger.api.log-level" : {
+ "type" : "string",
+ "enum" : [ "off", "fatal", "error", "warn", "info", "debug", "trace" ]
+ },
+ "metabase.logger.api.time-unit" : {
+ "type" : "string",
+ "enum" : [ "days", "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds" ]
+ },
+ "metabase.measures.api.RemappedValueResponse" : {
+ "description" : "Response schema for dimension remapping endpoint.\n Returns [value] if no remapping, or [value, display-name] if remapped.",
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ { } ]
}, {
- "type" : "null"
+ "type" : "array",
+ "prefixItems" : [ { }, {
+ "type" : "string"
+ } ]
} ]
},
- "metabase.lib.schema.metadata.desired-column-alias" : {
- "description" : "Name we should use as a column alias for a column in this stage of a query. The desired column alias in stage N\n becomes the source column alias in stage N+1. The right-hand side (RHS) in\n\n SELECT lhs AS rhs",
- "type" : "string"
- },
- "metabase.lib.schema.metadata.fingerprint..fingerprint.global" : {
- "description" : "Fingerprint values that Fields of all types should have.",
+ "metabase.measures.api.measure" : {
+ "description" : "Schema for a Measure entity as returned from the API.",
"type" : "object",
"properties" : {
- "distinct-count" : {
- "type" : "integer"
+ "dimension_mappings" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "nil%" : {
+ "entity_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
+ "type" : "string"
}, {
"type" : "null"
} ]
- }
- }
- },
- "metabase.lib.schema.metadata.fingerprint..fingerprint.number" : {
- "description" : "Schema for fingerprint information for Fields deriving from `:type/Number`.",
- "type" : "object",
- "properties" : {
- "avg" : {
+ },
+ "result_column_name" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "max" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "creator" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "object",
+ "properties" : { }
}, {
"type" : "null"
} ]
},
- "min" : {
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "archived" : {
+ "type" : "boolean"
+ },
+ "dimensions" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
}, {
"type" : "null"
} ]
},
- "q1" : {
+ "updated_at" : { },
+ "table_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "definition" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "created_at" : { },
+ "creator_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "table_id", "definition", "archived", "creator_id", "created_at", "updated_at" ]
+ },
+ "metabase.metabot.client.schema.message" : {
+ "type" : "object",
+ "properties" : {
+ "content" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "q3" : {
+ "role" : {
+ "$ref" : "#/components/schemas/metabase.metabot.client.schema.role"
+ },
+ "tool_call_id" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "sd" : {
+ "tool_calls" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "arguments" ]
+ }
}, {
"type" : "null"
} ]
}
+ },
+ "required" : [ "role" ]
+ },
+ "metabase.metabot.client.schema.messages" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.client.schema.message"
}
},
- "metabase.lib.schema.metadata.fingerprint..fingerprint.temporal" : {
- "description" : "Schema for fingerprint information for Fields deriving from `:type/Temporal`.",
+ "metabase.metabot.client.schema.role" : {
+ "type" : "string",
+ "enum" : [ "system", "user", "assistant", "tool" ]
+ },
+ "metabase.metabot.context.context" : {
+ "type" : "object",
+ "additionalProperties" : { }
+ },
+ "metabase.metabot.tools.api.aggregation" : {
+ "description" : "Aggregation — count (field optional), field-based (field required), or measure-based.",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.count-aggregation"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.field-aggregation"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.measure-aggregation"
+ } ]
+ },
+ "metabase.metabot.tools.api.answer-sources-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "with_metric_default_temporal_breakout" : {
+ "default" : true,
+ "type" : "boolean"
+ },
+ "with_metric_queryable_dimensions" : {
+ "default" : true,
+ "type" : "boolean"
+ },
+ "with_model_fields" : {
+ "default" : true,
+ "type" : "boolean"
+ },
+ "with_model_metrics" : {
+ "default" : true,
+ "type" : "boolean"
+ }
+ }
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.answer-sources-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "metrics" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.full-metric"
+ }
+ },
+ "models" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.table-result"
+ }
+ }
+ },
+ "required" : [ "metrics", "models" ]
+ }
+ },
+ "required" : [ "structured_output" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
+ } ]
+ },
+ "metabase.metabot.tools.api.basic-metric" : {
"type" : "object",
"properties" : {
- "earliest" : {
+ "default_time_dimension_field_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "latest" : {
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "const" : "metric"
}
- }
+ },
+ "required" : [ "id", "type", "name" ]
},
- "metabase.lib.schema.metadata.fingerprint..fingerprint.text" : {
- "description" : "Schema for fingerprint information for Fields deriving from `:type/Text`.",
+ "metabase.metabot.tools.api.basic-snippet" : {
"type" : "object",
"properties" : {
- "average-length" : {
+ "description" : {
"oneOf" : [ {
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "percent-email" : {
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ]
+ },
+ "metabase.metabot.tools.api.bucket" : {
+ "type" : "string",
+ "enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year", "second-of-minute", "minute-of-hour", "hour-of-day", "day-of-week", "day-of-month", "day-of-year", "week-of-year", "month-of-year", "quarter-of-year", "year-of-era" ]
+ },
+ "metabase.metabot.tools.api.column" : {
+ "type" : "object",
+ "properties" : {
+ "database_type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "percent-json" : {
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "percent-state" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "field_values" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.field-values"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "percent-url" : {
+ "type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.percent"
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.field-type"
}, {
"type" : "null"
} ]
}
+ },
+ "required" : [ "field_id", "name", "type" ]
+ },
+ "metabase.metabot.tools.api.columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.column"
}
},
- "metabase.lib.schema.metadata.fingerprint..fingerprint.type-specific" : {
- "description" : "Schema for type-specific fingerprint information.",
+ "metabase.metabot.tools.api.count" : {
+ "type" : "integer"
+ },
+ "metabase.metabot.tools.api.count-aggregation" : {
+ "description" : "Count aggregation — counts rows, no field_id needed.\n Use sort_order to order results by this aggregation ('asc' or 'desc').",
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "bucket" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.bucket"
+ },
+ "function" : {
+ "const" : "count"
+ },
+ "sort_order" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "asc", "desc" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "function" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.create-alert-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "card_id" : {
+ "type" : "integer"
+ },
+ "schedule" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.subscription-schedule"
+ },
+ "send_condition" : {
+ "type" : "string",
+ "enum" : [ "has_result", "goal_above", "goal_below" ]
+ },
+ "send_once" : {
+ "default" : false,
+ "type" : "boolean"
+ },
+ "slack_channel" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "card_id", "send_condition", "schedule", "slack_channel" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.create-dashboard-subscription-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "dashboard_id" : {
+ "type" : "integer"
+ },
+ "schedule" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.subscription-schedule"
+ },
+ "slack_channel" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "dashboard_id", "slack_channel", "schedule" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.disjunctive-numeric-filter" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "operation" : {
+ "type" : "string",
+ "enum" : [ "equals", "not-equals" ]
+ },
+ "values" : {
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "number"
+ } ]
+ }
+ }
+ },
+ "required" : [ "field_id", "operation", "values" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.disjunctive-string-date-filter" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "operation" : {
+ "type" : "string",
+ "enum" : [ "equals", "not-equals", "string-contains", "string-not-contains", "string-starts-with", "string-ends-with" ]
+ },
+ "values" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "required" : [ "field_id", "operation", "values" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.disjunctive-temporal-extraction-filter" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "operation" : {
+ "type" : "string",
+ "enum" : [ "year-equals", "year-not-equals", "quarter-equals", "quarter-not-equals", "month-equals", "month-not-equals", "day-of-week-equals", "day-of-week-not-equals", "hour-equals", "hour-not-equals", "minute-equals", "minute-not-equals", "second-equals", "second-not-equals" ]
+ },
+ "values" : {
+ "type" : "array",
+ "items" : {
+ "type" : "integer"
+ }
+ }
+ },
+ "required" : [ "field_id", "operation", "values" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.disjunctive-temporal-filter" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "bucket" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.bucket"
+ },
+ "field_id" : {
+ "type" : "string"
+ },
+ "operation" : {
+ "type" : "string",
+ "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ]
+ },
+ "values" : {
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "integer"
+ } ]
+ }
+ }
+ },
+ "required" : [ "field_id", "operation", "values" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.existence-filter" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "operation" : {
+ "type" : "string",
+ "enum" : [ "is-null", "is-not-null", "string-is-empty", "string-is-not-empty", "is-true", "is-false" ]
+ }
+ },
+ "required" : [ "field_id", "operation" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.field" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "bucket" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.bucket"
+ },
+ "field_id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "field_id" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.field-aggregation" : {
+ "description" : "Aggregation using a field and function. field_id is required.\n Use sort_order to order results by this aggregation ('asc' or 'desc').",
"allOf" : [ {
"type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : { }
+ "properties" : {
+ "bucket" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.bucket"
+ },
+ "field_id" : {
+ "type" : "string"
+ },
+ "function" : {
+ "type" : "string",
+ "enum" : [ "avg", "count-distinct", "max", "min", "sum" ]
+ },
+ "sort_order" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "asc", "desc" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "field_id", "function" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.field-type" : {
+ "type" : "string",
+ "enum" : [ "boolean", "date", "datetime", "time", "number", "string" ]
+ },
+ "metabase.metabot.tools.api.field-values" : {
+ "anyOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "boolean"
+ }
+ }, {
+ "type" : "array",
+ "items" : {
+ "type" : "number"
}
}, {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ } ]
+ },
+ "metabase.metabot.tools.api.field-values-arguments" : {
+ "allOf" : [ {
"type" : "object",
"properties" : {
- "type/DateTime" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.temporal"
+ "entity_id" : {
+ "type" : "integer"
},
- "type/Number" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.number"
+ "entity_type" : {
+ "type" : "string",
+ "enum" : [ "table", "model", "metric" ]
},
- "type/Text" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.text"
+ "field_id" : {
+ "type" : "string"
+ },
+ "limit" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
}
- }
+ },
+ "required" : [ "entity_type", "entity_id", "field_id" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.metadata.fingerprint.fingerprint" : {
- "description" : "Schema for a Field 'fingerprint' generated as part of the analysis stage. Used to power the 'classification'\n sub-stage of analysis. Stored as the `fingerprint` column of Field.",
- "type" : "object",
- "properties" : {
- "experimental" : {
- "type" : "object",
- "additionalProperties" : { }
+ "metabase.metabot.tools.api.field-values-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "value_metadata" : {
+ "type" : "object",
+ "properties" : {
+ "field_values" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "statistics" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.statistics"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ },
+ "required" : [ "field_id", "value_metadata" ]
+ }
},
- "global" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.global"
+ "required" : [ "structured_output" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
},
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint..fingerprint.type-specific"
- }
- }
+ "required" : [ "output" ]
+ } ]
},
- "metabase.lib.schema.metadata.fingerprint.percent" : {
- "description" : "Schema for something represting a percentage. A floating-point value between (inclusive) 0 and 1.",
- "type" : "number"
+ "metabase.metabot.tools.api.filter" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.segment-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.existence-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.temporal-extraction-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.disjunctive-temporal-extraction-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.temporal-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.disjunctive-temporal-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.string-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.disjunctive-string-date-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.numeric-filter"
+ }, {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.disjunctive-numeric-filter"
+ } ]
},
- "metabase.lib.schema.metadata.lib-or-legacy-column" : {
- "description" : "Schema for the maps in card `:result-metadata` and similar. These can be either\n `:metabase.lib.schema.metadata/result-metadata` (i.e., kebab-cased) maps, or map snake_cased as returned by QP\n metadata, but they should NOT be a mixture of both -- if we mixed them somehow there is a bug in our code.",
- "oneOf" : [ {
- "description" : "Malli schema for a valid map of column metadata, which can mean one of two things:\n\n 1. Metadata about a particular Field in the application database. This will always have an `:id`\n\n 2. Results metadata from a column in `data.cols` and/or `data.results_metadata.columns` in a Query Processor\n response, or saved in something like `Card.result_metadata`. These *may* have an `:id`, or may not -- columns\n coming back from native queries or things like `SELECT count(*)` aren't associated with any particular `Field`\n and thus will not have an `:id`.\n\n Now maybe these should be two different schemas, but `:id` being there or not is the only real difference; besides\n that they are largely compatible. So they're the same for now. We can revisit this in the future if we actually want\n to differentiate between the two versions.",
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "visibility-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
- }, {
- "type" : "null"
- } ]
- },
- "fk-join-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- }, {
- "type" : "null"
- } ]
- },
- "metabase.lib.metadata.result-metadata/field-ref" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
- }, {
- "type" : "null"
- } ]
- },
- "lib/external-remap" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
- }, {
- "type" : "null"
- } ]
- },
- "inherited-temporal-unit" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }, {
- "type" : "null"
- } ]
- },
- "lib/source-column-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.source-column-alias"
- }, {
- "type" : "null"
- } ]
- },
- "database-type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/temporal-unit" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }, {
- "type" : "null"
- } ]
- },
- "lib/type" : {
- "default" : "metadata/column",
- "const" : "metadata/column"
- },
- "settings" : {
- "oneOf" : [ {
+ "metabase.metabot.tools.api.filter-records-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "data_source" : {
+ "allOf" : [ {
+ "anyOf" : [ {
"type" : "object",
- "additionalProperties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "fingerprint" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/source-uuid" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- }, {
- "type" : "null"
- } ]
- },
- "qp/implicit-field?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/ref-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- }, {
- "type" : "null"
- } ]
- },
- "effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "lib/deduplicated-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.deduplicated-name"
- },
- "base-type" : {
- "default" : "type/*",
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "lib/transformation-added-base-type" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-expression-name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "fk-field-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/from-model?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "lib/card-id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }, {
- "type" : "null"
- } ]
- },
- "lib/expression-name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/breakout?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-effective-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "lib/join-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- }, {
- "type" : "null"
- } ]
- },
- "nfc-path" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }, {
- "type" : "null"
- } ]
- },
- "qp/native-sandbox-column.propagate-coercion?" : {
- "type" : "boolean"
- },
- "has-field-values" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
- }, {
- "type" : "null"
- } ]
- },
- "lib/internal-remap" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
- }, {
- "type" : "null"
- } ]
- },
- "selected?" : {
- "type" : "boolean"
- },
- "fk-field-id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-binning" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-join-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "qp/native-sandbox-column.force-coercion-strategy" : {
- "type" : "string"
- },
- "lib/binning" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- }, {
- "type" : "null"
- } ]
- },
- "metabase.lib.metadata.result-metadata/source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
- }, {
- "type" : "null"
- } ]
- },
- "lib/source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
- }, {
- "type" : "null"
- } ]
- },
- "active" : {
- "type" : "boolean"
- },
- "lib/ref-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
- },
- "semantic-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
- },
- "fk-target-field-id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- }, {
- "type" : "null"
- } ]
- },
- "lib/simple-display-name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "properties" : {
+ "query" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "database" ]
+ },
+ "query_id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "query" ]
}, {
- "type" : "null"
- } ]
- },
- "lib/desired-column-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.desired-column-alias"
+ "type" : "object",
+ "properties" : {
+ "report_id" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "report_id" ]
}, {
- "type" : "null"
+ "type" : "object",
+ "properties" : {
+ "table_id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_id" ]
} ]
- }
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
},
- "required" : [ "lib/type", "name", "base-type" ]
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
- }, {
- "allOf" : [ ]
- } ]
+ "filters" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.filter"
+ }
+ }
+ },
+ "required" : [ "data_source", "filters" ]
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.metadata.metadata-provider" : {
- "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol.",
- "$ref" : "#/components/schemas/metabase.lib.metadata.protocols.metadata-provider"
- },
- "metabase.lib.schema.metadata.original-name" : {
- "description" : "The original name of the column as it appeared in the very first place it came from (i.e., the physical name of the\n column in the table it appears in). This should be the same as the `:lib/source-column-alias` for the very first\n usage of the column.\n Allowed to be blank because some databases like SQL Server allow blank column names.",
- "oneOf" : [ {
- "type" : "string"
+ "metabase.metabot.tools.api.filtering-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Query"
+ },
+ "query_id" : {
+ "type" : "string"
+ },
+ "result_columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.column"
+ }
+ },
+ "type" : {
+ "const" : "query"
+ }
+ },
+ "required" : [ "type", "query_id", "query", "result_columns" ]
+ }
+ },
+ "required" : [ "structured_output" ]
}, {
- "type" : "null"
- } ]
- },
- "metabase.lib.schema.metadata.source-column-alias" : {
- "description" : "Name for a column as returned/projected by the previous stage of the query or source Table/source Card. The\n left-hand side (LHS) of\n\n SELECT lhs AS rhs",
- "type" : "string"
- },
- "metabase.lib.schema.metadata.stage" : {
- "description" : "Metadata about the columns returned by a particular stage of a pMBQL query. For example a single-stage native query\n like\n\n {:database 1\n :lib/type :mbql/query\n :stages [{:lib/type :mbql.stage/mbql\n :native \"SELECT id, name FROM VENUES;\"}]}\n\n might have stage metadata like\n\n {:columns [{:name \"id\", :base-type :type/Integer}\n {:name \"name\", :base-type :type/Text}]}\n\n associated with the query's lone stage.\n\n At some point in the near future we will hopefully attach this metadata directly to each stage in a query, so a\n multi-stage query will have `:lib/stage-metadata` for each stage. The main goal is to facilitate things like\n returning lists of visible or filterable columns for a given stage of a query. This is TBD, see #28717 for a WIP\n implementation of this idea.\n\n This is the same format as the results metadata returned with QP results in `data.results_metadata`. The `:columns`\n portion of this (`data.results_metadata.columns`) is also saved as `Card.result_metadata` for Saved Questions.\n\n Note that queries currently actually come back with both `data.results_metadata` AND `data.cols`; it looks like the\n Frontend actually *merges* these together -- see `applyMetadataDiff` in\n `frontend/src/metabase/query_builder/selectors.js` -- but this is ridiculous. Let's try to merge anything missing in\n `results_metadata` into `cols` going forward so things don't need to be manually merged in the future.",
- "type" : "object",
- "properties" : {
- "columns" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.column"
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
}
},
- "lib/type" : {
- "default" : "metadata/results",
- "const" : "metadata/results"
- }
- },
- "required" : [ "lib/type", "columns" ]
+ "required" : [ "output" ]
+ } ]
},
- "metabase.lib.schema.middleware-options.middleware-options" : {
- "description" : "Additional options that can be used to toggle middleware on or off.",
+ "metabase.metabot.tools.api.full-metric" : {
"type" : "object",
"properties" : {
- "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.",
+ "default_time_dimension_field_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "disable-max-results?" : {
- "description" : "Disable applying a default limit on the query results. Handled in the `add-default-limit` middleware. If true,\n this will override the `:max-results` and `:max-results-bare-rows` values in `Constraints`.",
- "type" : "boolean"
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "disable-mbql->native?" : {
- "description" : "Disable the MBQL->native middleware. If you do this, the query will not work at all, so there are no cases where\n you should set this yourself. This is only used by the `metabase.query-processor.preprocess/preprocess` function to\n get the fully pre-processed query without attempting to convert it to native.",
- "type" : "boolean"
+ "id" : {
+ "type" : "integer"
},
- "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`.",
+ "name" : {
+ "type" : "string"
+ },
+ "queryable_dimensions" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.columns"
+ },
+ "segments" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.segment"
+ }
+ },
+ "type" : {
+ "const" : "metric"
+ },
+ "verified" : {
"type" : "boolean"
+ }
+ },
+ "required" : [ "id", "type", "name" ]
+ },
+ "metabase.metabot.tools.api.full-snippet" : {
+ "type" : "object",
+ "properties" : {
+ "content" : {
+ "type" : "string"
},
- "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`.",
+ "description" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "skip-results-metadata?" : {
- "description" : "Should we skip adding `results_metadata` to query results after running the query? Used by\n `metabase.query-processor.middleware.results-metadata`; default `false`. (Note: we may change the name of this\n column in the near future, to `result_metadata`, to fix inconsistencies in how we name things.)",
- "type" : "boolean"
+ "id" : {
+ "type" : "integer"
},
- "userland-query?" : {
- "description" : "Userland queries are ones ran as a result of an API call, Pulse, or the like. Special handling is done in\n certain userland-only middleware for such queries -- results are returned in a slightly different format, and\n QueryExecution entries are normally saved, unless you pass `:no-save` as the option.",
- "oneOf" : [ {
- "type" : "boolean"
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "content" ]
+ },
+ "metabase.metabot.tools.api.generate-insights-arguments" : {
+ "type" : "object",
+ "properties" : {
+ "for" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "metric_id" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "metric_id" ]
}, {
- "type" : "null"
+ "type" : "object",
+ "properties" : {
+ "table_id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "report_id" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "report_id" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "query" ]
} ]
}
- }
+ },
+ "required" : [ "for" ]
},
- "metabase.lib.schema.order-by.order-by" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/mbql.clause.asc"
+ "metabase.metabot.tools.api.get-current-user-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "email_address" : {
+ "type" : "string"
+ },
+ "glossary" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "const" : "user"
+ }
+ },
+ "required" : [ "id", "type", "name", "email_address", "glossary" ]
+ }
+ },
+ "required" : [ "structured_output" ]
}, {
- "$ref" : "#/components/schemas/mbql.clause.desc"
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
} ]
},
- "metabase.lib.schema.order-by.order-bys" : {
+ "metabase.metabot.tools.api.get-dashboard-details-arguments" : {
"allOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.order-by.order-by"
+ "type" : "object",
+ "properties" : {
+ "dashboard_id" : {
+ "type" : "integer"
+ }
},
- "minItems" : 1
+ "required" : [ "dashboard_id" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.page" : {
- "description" : "`page` = page num, starting with 1. `items` = number of items per page.\n e.g.\n\n {:page 1, :items 10} = items 1-10\n {:page 2, :items 10} = items 11-20",
- "type" : "object",
- "properties" : {
- "items" : {
- "type" : "integer",
- "minimum" : 1
+ "metabase.metabot.tools.api.get-dashboard-details-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "const" : "dashboard"
+ },
+ "verified" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "id", "type", "name" ]
+ }
},
- "page" : {
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "page", "items" ]
+ "required" : [ "structured_output" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
+ } ]
},
- "metabase.lib.schema.parameter..dimension.options" : {
+ "metabase.metabot.tools.api.get-document-details-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "document_id" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "document_id" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.get-document-details-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "document" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "document" ]
+ }
+ },
+ "required" : [ "structured_output" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
+ } ]
+ },
+ "metabase.metabot.tools.api.get-metric-details-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "metric_id" : {
+ "type" : "integer"
+ },
+ "with_default_temporal_breakout" : {
+ "default" : true,
+ "type" : "boolean"
+ },
+ "with_field_values" : {
+ "default" : true,
+ "type" : "boolean"
+ },
+ "with_queryable_dimensions" : {
+ "default" : true,
+ "type" : "boolean"
+ },
+ "with_segments" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "metric_id" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.get-metric-details-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.full-metric"
+ }
+ },
+ "required" : [ "structured_output" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
+ } ]
+ },
+ "metabase.metabot.tools.api.get-query-details-arguments" : {
"type" : "object",
"properties" : {
- "stage-number" : {
- "type" : "integer"
+ "query" : {
+ "type" : "object",
+ "properties" : { }
}
- }
+ },
+ "required" : [ "query" ]
},
- "metabase.lib.schema.parameter..dimension.target" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-expression-ref"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.template-tag"
+ "metabase.metabot.tools.api.get-query-details-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "query_id" : {
+ "type" : "string"
+ },
+ "result_columns" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.columns"
+ },
+ "type" : {
+ "const" : "query"
+ }
+ },
+ "required" : [ "type", "query_id", "query", "result_columns" ]
+ }
+ },
+ "required" : [ "structured_output" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
} ]
},
- "metabase.lib.schema.parameter..parameter.value" : { },
- "metabase.lib.schema.parameter..target.legacy-expression-ref" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.expression"
- },
- "metabase.lib.schema.parameter..target.legacy-field-ref" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field"
+ "metabase.metabot.tools.api.get-report-details-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "report_id" : {
+ "type" : "integer"
+ },
+ "with_field_values" : {
+ "default" : true,
+ "type" : "boolean"
+ },
+ "with_fields" : {
+ "default" : true,
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "report_id" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
},
- "metabase.lib.schema.parameter..template-tag.tag-name" : {
- "oneOf" : [ {
+ "metabase.metabot.tools.api.get-report-details-result" : {
+ "anyOf" : [ {
"type" : "object",
"properties" : {
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "result_columns" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.columns"
+ },
+ "type" : {
+ "const" : "question"
+ },
+ "verified" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "id", "type", "name", "result_columns" ]
}
},
- "required" : [ "id" ]
+ "required" : [ "structured_output" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
} ]
},
- "metabase.lib.schema.parameter..variable.target" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
+ "metabase.metabot.tools.api.get-snippet-details-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "snippet_id" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "snippet_id" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.template-tag"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.parameter.dimension" : { },
- "metabase.lib.schema.parameter.id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "metabase.metabot.tools.api.get-snippet-details-result" : {
+ "description" : "Schema for SQL snippet detail results",
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.full-snippet"
+ }
+ },
+ "required" : [ "structured_output" ]
+ },
+ "metabase.metabot.tools.api.get-snippets-result" : {
+ "description" : "Schema for SQL snippet list results",
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.basic-snippet"
+ }
+ }
+ },
+ "required" : [ "structured_output" ]
},
- "metabase.lib.schema.parameter.parameter" : {
- "description" : "Schema for the *value* of a parameter (e.g. a Dashboard parameter or a native query template tag) as passed in as\n part of the `:parameters` list in a query.\n\n Note that this is different from the parameter declarations that are saved as part of Dashboards and Cards; for THAT\n schema refer to `:metabase.parameters.schema/parameter`.",
+ "metabase.metabot.tools.api.get-table-details-arguments" : {
"allOf" : [ {
"type" : "object",
"properties" : {
- "default" : { },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
+ "with_metric_default_temporal_breakout" : {
+ "default" : true,
+ "type" : "boolean"
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "with_fields" : {
+ "default" : true,
+ "type" : "boolean"
},
- "required" : { },
- "slug" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "with_field_values" : {
+ "default" : true,
+ "type" : "boolean"
},
- "target" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ "with_related_tables" : {
+ "default" : true,
+ "type" : "boolean"
},
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
+ "with_segments" : {
+ "default" : false,
+ "type" : "boolean"
},
- "value" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..parameter.value"
+ "with_metrics" : {
+ "default" : true,
+ "type" : "boolean"
+ },
+ "table_id" : {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "string"
+ } ]
+ },
+ "with_measures" : {
+ "default" : false,
+ "type" : "boolean"
+ },
+ "model_id" : {
+ "type" : "integer"
}
- },
- "required" : [ "type" ]
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
- } ]
- },
- "metabase.lib.schema.parameter.parameters" : {
- "description" : "Schema for a list of `:parameters` as passed in to a query.",
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameter"
- }
- },
- "metabase.lib.schema.parameter.target" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.dimension"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.variable"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.text-tag"
+ }
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.parameter.template-tag" : {
- "description" : "This is the reference like [:template-tag <whatever>], not the schema for native query template tags -- that lives\n in [[metabase.lib.schema.template-tag]].",
- "type" : "array",
- "prefixItems" : [ {
- "const" : "template-tag"
+ "metabase.metabot.tools.api.get-table-details-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.table-result"
+ }
+ },
+ "required" : [ "structured_output" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..template-tag.tag-name"
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
} ]
},
- "metabase.lib.schema.parameter.text-tag" : {
- "description" : "A :text-tag parameter :target applies to parameterized text cards in viz settings",
- "type" : "array",
- "prefixItems" : [ {
- "const" : "text-tag"
+ "metabase.metabot.tools.api.get-tables-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "database_id" ]
}, {
- "type" : "string"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.parameter.type" : {
- "description" : "Valid parameter :type",
- "default" : "text",
- "type" : "string",
- "enum" : [ "number", "text", "date", "boolean", "date/single", "id", "category", "location/city", "location/state", "location/zip_code", "location/country", "date/range", "date/month-year", "date/quarter-year", "date/relative", "date/all-options", "temporal-unit", "number/!=", "number/<=", "number/=", "number/>=", "number/between", "string/!=", "string/=", "string/contains", "string/does-not-contain", "string/ends-with", "string/starts-with", "boolean/=" ]
- },
- "metabase.lib.schema.parameter.variable" : {
- "type" : "array",
- "prefixItems" : [ {
- "const" : "variable"
+ "metabase.metabot.tools.api.get-tables-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "type" : "string"
+ },
+ "engine" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "engine", "name", "description" ]
+ },
+ "tables" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "description", "type" ]
+ }
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "description", "columns" ]
+ }
+ }
+ },
+ "required" : [ "database", "tables" ]
+ }
+ },
+ "required" : [ "structured_output" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..variable.target"
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
} ]
},
- "metabase.lib.schema.parameter.widget-type" : {
- "description" : "The type of widget to display in the FE UI for the user to use to pick values for this parameter.",
- "type" : "string",
- "enum" : [ "none", "number", "text", "date", "boolean", "date/single", "id", "category", "location/city", "location/state", "location/zip_code", "location/country", "date/range", "date/month-year", "date/quarter-year", "date/relative", "date/all-options", "temporal-unit", "number/!=", "number/<=", "number/=", "number/>=", "number/between", "string/!=", "string/=", "string/contains", "string/does-not-contain", "string/ends-with", "string/starts-with", "boolean/=" ]
- },
- "metabase.lib.schema.query" : {
+ "metabase.metabot.tools.api.group-by" : {
"allOf" : [ {
- "description" : "Valid MBQL 5 query.",
"type" : "object",
"properties" : {
- "lib/metadata" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.metadata-provider"
- },
- "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" : {
+ "field_granularity" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
+ "type" : "string",
+ "enum" : [ "minute", "hour", "day", "week", "month", "quarter", "year", "day-of-week" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ "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"
+ "field_id" : {
+ "type" : "string"
}
},
- "required" : [ "lib/type", "stages" ]
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.util.unique-uuids"
+ "required" : [ "field_id" ]
}, {
- "allOf" : [ ]
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.ref..expression.options" : {
- "default" : { },
+ "metabase.metabot.tools.api.measure" : {
"type" : "object",
"properties" : {
- "base-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "database-type" : {
+ "definition" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "object",
+ "properties" : { }
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "effective-type" : {
+ "display_name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "id" : {
+ "type" : "integer"
},
"name" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "semantic-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
- }, {
- "type" : "null"
- } ]
- },
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "type" : "string"
}
},
- "required" : [ "lib/uuid" ]
+ "required" : [ "id", "name" ]
},
- "metabase.lib.schema.ref..field.id" : {
- "type" : "array",
- "prefixItems" : [ {
- "const" : "field"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.ref..field.options"
+ "metabase.metabot.tools.api.measure-aggregation" : {
+ "description" : "Aggregation using a pre-defined measure.",
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "measure_id" : {
+ "type" : "integer"
+ },
+ "sort_order" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "asc", "desc" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "measure_id" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.ref..field.literal" : {
- "type" : "array",
- "prefixItems" : [ {
- "const" : "field"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.ref..field.literal.options"
+ "metabase.metabot.tools.api.numeric-filter" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "operation" : {
+ "type" : "string",
+ "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ]
+ },
+ "value" : {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "number"
+ } ]
+ }
+ },
+ "required" : [ "field_id", "operation", "value" ]
}, {
- "type" : "string"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.ref..field.literal.options" : {
+ "metabase.metabot.tools.api.order-by" : {
+ "description" : "Order by item specifying a field and sort direction.",
+ "type" : "object",
+ "properties" : {
+ "direction" : {
+ "type" : "string",
+ "enum" : [ "asc", "desc" ]
+ },
+ "field" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.field"
+ }
+ },
+ "required" : [ "field", "direction" ]
+ },
+ "metabase.metabot.tools.api.proportion" : {
+ "type" : "number"
+ },
+ "metabase.metabot.tools.api.query-datasource-arguments" : {
"allOf" : [ {
- "default" : { },
"type" : "object",
"properties" : {
- "binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "inherited-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "aggregations" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.aggregation"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "database-type" : {
+ "fields" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.field"
+ }
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "filters" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.filter"
+ }
}, {
"type" : "null"
} ]
},
- "source-field-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "group_by" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.group-by"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "effective-type" : {
+ "limit" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "base-type" : {
- "type" : "string"
+ "model_id" : {
+ "type" : "integer"
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "order_by" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.order-by"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
+ "table_id" : {
+ "type" : "integer"
+ }
+ }
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.query-metric-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "filters" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.filter"
+ }
}, {
"type" : "null"
} ]
},
- "lib/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "group_by" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.group-by"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "source-field" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "metric_id" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "metric_id" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.query-model-arguments" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "aggregations" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.aggregation"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "fields" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.field"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "lib/original-binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "filters" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.filter"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "group_by" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.group-by"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "source-field-join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "limit" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "semantic-type" : {
+ "model_id" : {
+ "type" : "integer"
+ },
+ "order_by" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.order-by"
+ }
}, {
"type" : "null"
} ]
- },
- "original-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
}
},
- "required" : [ "lib/uuid", "base-type" ]
+ "required" : [ "model_id" ]
}, {
- "allOf" : [ ]
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.ref..field.options" : {
+ "metabase.metabot.tools.api.search-arguments" : {
"allOf" : [ {
- "default" : { },
"type" : "object",
"properties" : {
- "binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "inherited-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "weights" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "number"
+ }
},
- "database-type" : {
+ "semantic_queries" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
}, {
"type" : "null"
} ]
},
- "display-name" : {
+ "limit" : {
+ "default" : 50,
+ "type" : "integer"
+ },
+ "database_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "source-field-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "effective-type" : {
+ "term_queries" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
}, {
"type" : "null"
} ]
},
- "base-type" : {
+ "entity_types" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "table", "model", "question", "dashboard", "metric", "database", "transform" ]
+ }
}, {
"type" : "null"
} ]
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- },
- "name" : {
+ "created_at" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "lib/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "source-field" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "lib/original-binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "source-field-join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "semantic-type" : {
+ "last_edited_at" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "original-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "search_native_query" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.search-result" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "structured_output" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.search-result-item"
+ }
+ },
+ "total_count" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "data", "total_count" ]
}
},
- "required" : [ "lib/uuid" ]
+ "required" : [ "structured_output" ]
}, {
- "allOf" : [ ]
+ "type" : "object",
+ "properties" : {
+ "output" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "output" ]
} ]
},
- "metabase.lib.schema.ref.aggregation-options" : {
- "default" : { },
+ "metabase.metabot.tools.api.search-result-item" : {
+ "description" : "Unified schema for search result items.",
"type" : "object",
"properties" : {
- "base-type" : {
+ "collection" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "object",
+ "properties" : {
+ "authority_level" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
}, {
"type" : "null"
} ]
},
- "database-type" : {
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "verified" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "display-name" : {
- "type" : "string",
- "minLength" : 1
- },
- "effective-type" : {
+ "database_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "lib/source-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "updated_at" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
+ "type" : {
"type" : "string",
- "minLength" : 1
+ "enum" : [ "table", "model", "dashboard", "question", "metric", "database", "transform" ]
},
- "semantic-type" : {
+ "database_schema" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "lib/uuid" ]
- },
- "metabase.lib.schema.ref.ref" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.mbql-clause.clause"
+ "required" : [ "id", "type", "name" ]
},
- "metabase.lib.schema.settings.settings" : {
- "description" : "Options that tweak the behavior of the query processor.",
+ "metabase.metabot.tools.api.segment" : {
"type" : "object",
"properties" : {
- "include-sensitive-fields" : {
- "description" : "Whether to include fields with visibility_type :sensitive when fetching query metadata.",
- "type" : "boolean"
+ "definition" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
},
- "report-timezone" : {
- "description" : "The timezone the query should be ran in, overriding the default report timezone for the instance.",
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal.timezone-id"
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
}
- }
- },
- "metabase.lib.schema.stage" : {
- "default" : {
- "lib/type" : "mbql.stage/mbql"
},
+ "required" : [ "id", "name" ]
+ },
+ "metabase.metabot.tools.api.segment-filter" : {
+ "description" : "Filter using a pre-defined segment.",
"allOf" : [ {
"type" : "object",
"properties" : {
- "lib/type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema..stage.type"
+ "segment_id" : {
+ "type" : "integer"
}
},
- "required" : [ "lib/type" ]
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema..stage.native"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema..stage.mbql"
- } ]
- }, {
- "allOf" : [ ]
- } ]
- },
- "metabase.lib.schema.stages" : {
- "allOf" : [ {
- "default" : [ ],
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.stage"
- },
- "minItems" : 1
+ "required" : [ "segment_id" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema..stages.valid-refs"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.template-tag..field-filter.options" : {
- "type" : "object",
- "properties" : { }
- },
- "metabase.lib.schema.template-tag..raw-value.type" : {
- "type" : "string",
- "enum" : [ "date", "number", "boolean", "text" ]
- },
- "metabase.lib.schema.template-tag..template-tag-map.validate-names" : { },
- "metabase.lib.schema.template-tag..value.common" : {
- "type" : "object",
- "properties" : {
- "default" : { },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
- },
- "required" : {
- "type" : "boolean"
- }
- },
- "required" : [ "name", "display-name" ]
- },
- "metabase.lib.schema.template-tag.common" : {
+ "metabase.metabot.tools.api.statistics" : {
"type" : "object",
"properties" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "values" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.field-values"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "min" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
- }
- },
- "required" : [ "name", "display-name" ]
- },
- "metabase.lib.schema.template-tag.disallow-dimension" : { },
- "metabase.lib.schema.template-tag.field-filter" : {
- "type" : "object",
- "properties" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "percent_url" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.proportion"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "average_length" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "earliest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : {
- "type" : "boolean"
+ "q1" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "const" : "dimension"
+ "max" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "alias" : {
- "type" : "string"
+ "distinct_count" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.count"
+ }, {
+ "type" : "null"
+ } ]
},
- "options" : {
+ "percent_state" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..field-filter.options"
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.proportion"
}, {
"type" : "null"
} ]
},
- "dimension" : {
- "$ref" : "#/components/schemas/mbql.clause.field"
+ "percent_null" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.proportion"
+ }, {
+ "type" : "null"
+ } ]
},
- "default" : { },
- "widget-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.widget-type"
- }
- },
- "required" : [ "name", "display-name", "type", "widget-type" ]
- },
- "metabase.lib.schema.template-tag.id" : {
- "oneOf" : [ {
- "type" : "string",
- "format" : "uuid"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- } ]
- },
- "metabase.lib.schema.template-tag.name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "metabase.lib.schema.template-tag.raw-value" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "default" : { },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
- },
- "required" : {
- "type" : "boolean"
- },
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..raw-value.type"
- }
+ "avg" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "name", "display-name", "type" ]
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
- } ]
- },
- "metabase.lib.schema.template-tag.snippet" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "database" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
- },
- "snippet-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
- },
- "snippet-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "type" : {
- "const" : "snippet"
- }
+ "sd" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "name", "display-name", "type", "snippet-name" ]
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
- } ]
- },
- "metabase.lib.schema.template-tag.source-filter" : {
- "description" : "Schema for a single source-filter applied to a table template tag.",
- "type" : "object",
- "properties" : {
- "field-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "percent_email" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.proportion"
+ }, {
+ "type" : "null"
+ } ]
},
- "op" : {
- "type" : "string",
- "enum" : [ "<=", ">", ">=", "!=", "=", "<" ]
+ "latest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "value" : { }
- },
- "required" : [ "field-id", "op", "value" ]
+ "q3" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "percent_json" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.proportion"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
},
- "metabase.lib.schema.template-tag.source-query" : {
+ "metabase.metabot.tools.api.string-filter" : {
"allOf" : [ {
"type" : "object",
"properties" : {
- "card-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "field_id" : {
+ "type" : "string"
},
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ "operation" : {
+ "type" : "string",
+ "enum" : [ "equals", "not-equals", "string-contains", "string-not-contains", "string-starts-with", "string-ends-with" ]
},
- "type" : {
- "const" : "card"
+ "value" : {
+ "type" : "string"
}
},
- "required" : [ "name", "display-name", "type", "card-id" ]
+ "required" : [ "field_id", "operation", "value" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.template-tag.source-table" : {
+ "metabase.metabot.tools.api.subscription-schedule" : {
"allOf" : [ {
- "type" : "object",
- "properties" : {
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "emit-alias" : {
- "type" : "boolean"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
- },
- "name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
- },
- "source-filters" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-filter"
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "frequency" : {
+ "const" : "hourly"
}
},
- "table-id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
- },
- "type" : {
- "const" : "table"
- }
- },
- "required" : [ "name", "display-name", "type", "table-id" ]
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
- } ]
- },
- "metabase.lib.schema.template-tag.template-tag" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.type"
- }
- },
- "required" : [ "type" ]
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.temporal-unit"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.field-filter"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.snippet"
+ "required" : [ "frequency" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-query"
+ "type" : "object",
+ "properties" : {
+ "frequency" : {
+ "const" : "daily"
+ },
+ "hour" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "frequency", "hour" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.source-table"
+ "type" : "object",
+ "properties" : {
+ "day_of_week" : {
+ "type" : "string",
+ "enum" : [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ]
+ },
+ "frequency" : {
+ "const" : "weekly"
+ },
+ "hour" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "frequency", "hour", "day_of_week" ]
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.raw-value"
+ "type" : "object",
+ "properties" : {
+ "day_of_month" : {
+ "type" : "string",
+ "enum" : [ "first-calendar-day", "middle-of-month", "last-calendar-day", "first-sunday", "first-monday", "first-tuesday", "first-wednesday", "first-thursday", "first-friday", "first-saturday", "last-sunday", "last-monday", "last-tuesday", "last-wednesday", "last-thursday", "last-friday", "last-saturday" ]
+ },
+ "frequency" : {
+ "const" : "monthly"
+ },
+ "hour" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "frequency", "hour", "day_of_month" ]
} ]
- } ]
- },
- "metabase.lib.schema.template-tag.template-tag-map" : {
- "allOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.template-tag"
- }
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..template-tag-map.validate-names"
+ "type" : "object",
+ "properties" : { }
} ]
},
- "metabase.lib.schema.template-tag.temporal-unit" : {
+ "metabase.metabot.tools.api.table-result" : {
"type" : "object",
"properties" : {
- "alias" : {
+ "database_engine" : {
"type" : "string"
},
- "dimension" : {
- "$ref" : "#/components/schemas/mbql.clause.field"
- },
- "display-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
"id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ "type" : "integer"
},
"name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
- },
- "type" : {
- "const" : "temporal-unit"
- }
- },
- "required" : [ "name", "display-name", "type" ]
- },
- "metabase.lib.schema.template-tag.type" : {
- "description" : "Schema for valid values of template tag `:type`.",
- "type" : "string",
- "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "boolean", "temporal-unit", "table" ]
- },
- "metabase.lib.schema.template-tag.widget-type" : {
- "description" : "Schema for valid values of `:widget-type` for a `:metabase.lib.schema.template-tag/field-filter` template tag.",
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.widget-type"
- },
- "metabase.lib.schema.temporal-bucketing..unit.date" : {
- "type" : "string",
- "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "month", "month-of-year", "quarter", "quarter-of-year", "week", "week-of-year", "year", "year-of-era" ]
- },
- "metabase.lib.schema.temporal-bucketing..unit.date-time" : {
- "type" : "string",
- "enum" : [ "millisecond", "second", "minute", "hour", "day", "week", "month", "quarter", "year", "second-of-minute", "minute-of-hour", "hour-of-day", "day-of-week", "day-of-month", "day-of-year", "week-of-year", "month-of-year", "quarter-of-year", "year-of-era" ]
- },
- "metabase.lib.schema.temporal-bucketing..unit.date-time.interval" : {
- "type" : "string",
- "enum" : [ "day", "hour", "millisecond", "minute", "month", "quarter", "second", "week", "year" ]
- },
- "metabase.lib.schema.temporal-bucketing..unit.time.interval" : {
- "type" : "string",
- "enum" : [ "hour", "millisecond", "minute", "second" ]
- },
- "metabase.lib.schema.temporal-bucketing.unit" : {
- "type" : "string",
- "enum" : [ "day", "day-of-month", "day-of-week", "day-of-year", "default", "hour", "hour-of-day", "millisecond", "minute", "minute-of-hour", "month", "month-of-year", "quarter", "quarter-of-year", "second", "second-of-minute", "week", "week-of-year", "year", "year-of-era" ]
- },
- "metabase.lib.schema.util.distinct-mbql-clauses" : { },
- "metabase.lib.schema.util.unique-uuids" : { },
- "metabase.lib.schema.validate.source-entity-type" : {
- "description" : "The type of the source entity causing an error.",
- "type" : "string",
- "enum" : [ "table", "card" ]
- },
- "metabase.lib.schema.validate.validate-error-type" : {
- "type" : "string",
- "enum" : [ "missing-column", "missing-table-alias", "duplicate-column", "syntax-error", "validation-exception-error" ]
- },
- "metabase.logger.api.log-level" : {
- "type" : "string",
- "enum" : [ "off", "fatal", "error", "warn", "info", "debug", "trace" ]
- },
- "metabase.logger.api.time-unit" : {
- "type" : "string",
- "enum" : [ "days", "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds" ]
- },
- "metabase.measures.api.RemappedValueResponse" : {
- "description" : "Response schema for dimension remapping endpoint.\n Returns [value] if no remapping, or [value, display-name] if remapped.",
- "anyOf" : [ {
- "type" : "array",
- "prefixItems" : [ { } ]
- }, {
- "type" : "array",
- "prefixItems" : [ { }, {
"type" : "string"
- } ]
- } ]
- },
- "metabase.measures.api.measure" : {
- "description" : "Schema for a Measure entity as returned from the API.",
- "type" : "object",
- "properties" : {
- "dimension_mappings" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
},
- "entity_id" : {
+ "database_id" : {
+ "type" : "integer"
+ },
+ "related_tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.table-result"
+ }
+ },
+ "related_by" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "result_column_name" : {
+ "display_name" : {
+ "type" : "string"
+ },
+ "segments" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.segment"
+ }
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "model", "table" ]
+ },
+ "fields" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.columns"
+ },
+ "database_schema" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "metrics" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.basic-metric"
+ }
},
- "creator" : {
+ "measures" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.measure"
+ }
+ },
+ "description" : {
"oneOf" : [ {
- "type" : "object",
- "properties" : { }
+ "type" : "string"
}, {
"type" : "null"
} ]
+ }
+ },
+ "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]
+ },
+ "metabase.metabot.tools.api.temporal-extraction-filter" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "operation" : {
+ "type" : "string",
+ "enum" : [ "year-equals", "year-not-equals", "quarter-equals", "quarter-not-equals", "month-equals", "month-not-equals", "day-of-week-equals", "day-of-week-not-equals", "hour-equals", "hour-not-equals", "minute-equals", "minute-not-equals", "second-equals", "second-not-equals" ]
+ },
+ "value" : {
+ "type" : "integer"
+ }
},
- "name" : {
- "type" : "string",
- "minLength" : 1
+ "required" : [ "field_id", "operation", "value" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.api.temporal-filter" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "bucket" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.bucket"
+ },
+ "field_id" : {
+ "type" : "string"
+ },
+ "operation" : {
+ "type" : "string",
+ "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ]
+ },
+ "value" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "integer"
+ } ]
+ }
},
- "archived" : {
- "type" : "boolean"
+ "required" : [ "field_id", "operation", "value" ]
+ }, {
+ "type" : "object",
+ "properties" : { }
+ } ]
+ },
+ "metabase.metabot.tools.deftool.tool-request" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "dimensions" : {
+ "metabot_id" : {
"oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "updated_at" : { },
- "table_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "definition" : {
- "type" : "object",
- "properties" : { }
- },
- "created_at" : { },
- "creator_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "description" : {
+ "profile_id" : {
"oneOf" : [ {
"type" : "string"
}, {
@@ -13426,7 +13162,7 @@
} ]
}
},
- "required" : [ "id", "name", "table_id", "definition", "archived", "creator_id", "created_at", "updated_at" ]
+ "required" : [ "conversation_id" ]
},
"metabase.metrics.api.BreakoutValuesResponse" : {
"type" : "object",
@@ -16516,7 +16252,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.construct-query-response"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-response"
}
}
}
@@ -16532,7 +16268,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.construct-query-request"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.construct-query-request"
}
}
}
@@ -16552,7 +16288,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.execute-query-response"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.execute-query-response"
}
}
}
@@ -16568,7 +16304,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.execute-query-request"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.execute-query-request"
}
}
}
@@ -16641,7 +16377,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.metric"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.metric"
}
}
}
@@ -16685,7 +16421,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field-values"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field-values"
}
}
}
@@ -16745,7 +16481,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.search-response"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.search-response"
}
}
}
@@ -16880,7 +16616,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.table"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.table"
}
}
}
@@ -16924,7 +16660,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field-values"
+ "$ref" : "#/components/schemas/metabase.agent-api.api.field-values"
}
}
}
@@ -18552,6 +18288,168 @@
"tags" : [ "/api/agent/v1/workspace" ]
}
},
+ "/api/ai-entity-analysis/analyze-chart" : {
+ "post" : {
+ "operationId" : "post-api-ai-entity-analysis-analyze-chart",
+ "summary" : "POST /api/ai-entity-analysis/analyze-chart",
+ "description" : "Analyze a chart image using an AI vision model. This function sends the image data to a separate external AI service\n for analysis.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "image_base64" : {
+ "type" : "string"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timeline_events" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "timestamp" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "timestamp" ]
+ }
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "image_base64" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ai-entity-analysis" ]
+ }
+ },
+ "/api/ai-sql-fixer/fix" : {
+ "post" : {
+ "operationId" : "post-api-ai-sql-fixer-fix",
+ "summary" : "POST /api/ai-sql-fixer/fix",
+ "description" : "Suggest fixes for a SQL query.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "error_message" : {
+ "type" : "string"
+ },
+ "query" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "database" ]
+ }
+ },
+ "required" : [ "query", "error_message" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ai-sql-fixer" ]
+ }
+ },
+ "/api/ai-sql-generation/generate" : {
+ "post" : {
+ "operationId" : "post-api-ai-sql-generation-generate",
+ "summary" : "POST /api/ai-sql-generation/generate",
+ "description" : "Generate a SQL query.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "prompt" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "prompt", "database_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ai-sql-generation" ]
+ }
+ },
"/api/alert" : {
"get" : {
"operationId" : "get-api-alert",
@@ -27066,168 +26964,6 @@
"tags" : [ "/api/ee/advanced-permissions/impersonation" ]
}
},
- "/api/ee/ai-entity-analysis/analyze-chart" : {
- "post" : {
- "operationId" : "post-api-ee-ai-entity-analysis-analyze-chart",
- "summary" : "POST /api/ee/ai-entity-analysis/analyze-chart",
- "description" : "Analyze a chart image using an AI vision model. This function sends the image data to a separate external AI service\n for analysis.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "image_base64" : {
- "type" : "string"
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "timeline_events" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "timestamp" : {
- "type" : "string"
- }
- },
- "required" : [ "name", "timestamp" ]
- }
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "image_base64" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/ai-entity-analysis" ]
- }
- },
- "/api/ee/ai-sql-fixer/fix" : {
- "post" : {
- "operationId" : "post-api-ee-ai-sql-fixer-fix",
- "summary" : "POST /api/ee/ai-sql-fixer/fix",
- "description" : "Suggest fixes for a SQL query.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "error_message" : {
- "type" : "string"
- },
- "query" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "database" ]
- }
- },
- "required" : [ "query", "error_message" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/ai-sql-fixer" ]
- }
- },
- "/api/ee/ai-sql-generation/generate" : {
- "post" : {
- "operationId" : "post-api-ee-ai-sql-generation-generate",
- "summary" : "POST /api/ee/ai-sql-generation/generate",
- "description" : "Generate a SQL query.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "prompt" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "prompt", "database_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/ai-sql-generation" ]
- }
- },
"/api/ee/audit-app/analytics-dev/export" : {
"post" : {
"operationId" : "post-api-ee-audit-app-analytics-dev-export",
@@ -27308,150 +27044,6 @@
"tags" : [ "/api/ee/audit-app/user" ]
}
},
- "/api/ee/autodescribe/card/summarize" : {
- "post" : {
- "operationId" : "post-api-ee-autodescribe-card-summarize",
- "summary" : "POST /api/ee/autodescribe/card/summarize",
- "description" : "Summarize a question.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "visualization_settings" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- },
- "dataset" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "dataset_query" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
- }
- }, {
- "type" : "null"
- } ]
- },
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "result_metadata" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "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" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
- }
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "dataset_query", "display", "visualization_settings" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/autodescribe" ]
- }
- },
- "/api/ee/autodescribe/dashboard/summarize/{id}" : {
- "post" : {
- "operationId" : "post-api-ee-autodescribe-dashboard-summarize-id",
- "summary" : "POST /api/ee/autodescribe/dashboard/summarize/{id}",
- "description" : "Provide a summary of a dashboard.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/autodescribe" ]
- }
- },
"/api/ee/billing" : {
"get" : {
"operationId" : "get-api-ee-billing",
@@ -28815,6 +28407,9 @@
"create-dashboard" : {
"type" : "boolean"
},
+ "move-dashboard-to-shared" : {
+ "type" : "boolean"
+ },
"setup-data-segregation-strategy" : {
"type" : "boolean"
},
@@ -28828,7 +28423,7 @@
"type" : "boolean"
}
},
- "required" : [ "add-data", "create-dashboard", "create-models", "configure-row-column-security", "create-test-embed", "embed-production", "sso-configured", "data-permissions-and-enable-tenants", "enable-tenants", "create-tenants", "setup-data-segregation-strategy", "sso-auth-manual-tested" ],
+ "required" : [ "add-data", "create-dashboard", "create-models", "configure-row-column-security", "create-test-embed", "embed-production", "sso-configured", "data-permissions-and-enable-tenants", "enable-tenants", "move-dashboard-to-shared", "create-tenants", "setup-data-segregation-strategy", "sso-auth-manual-tested" ],
"additionalProperties" : false
},
"data-isolation-strategy" : {
@@ -29087,416 +28682,12 @@
"type" : "string",
"pattern" : "\\d{4}-\\d{2}"
},
- "description" : "Must be a string like 2020-04 or 2222-11."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/logs" ]
- }
- },
- "/api/ee/metabot-tools/answer-sources" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-answer-sources",
- "summary" : "POST /api/ee/metabot-tools/answer-sources",
- "description" : "Return top level meta information about available information sources.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.answer-sources-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/check-transform-dependencies" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-check-transform-dependencies",
- "summary" : "POST /api/ee/metabot-tools/check-transform-dependencies",
- "description" : "Check a proposed edit to a transform and return details of cards or transforms that would be broken by the change.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.check-transform-dependencies-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/create-alert" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-create-alert",
- "summary" : "POST /api/ee/metabot-tools/create-alert",
- "description" : "Create an alert for a saved question.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "error" : {
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.create-alert-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/create-dashboard-subscription" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-create-dashboard-subscription",
- "summary" : "POST /api/ee/metabot-tools/create-dashboard-subscription",
- "description" : "Create a dashboard subscription and send it to a slack channel.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "error" : {
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.create-dashboard-subscription-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/field-values" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-field-values",
- "summary" : "POST /api/ee/metabot-tools/field-values",
- "description" : "Return statistics and/or values for a given field of a given entity.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field-values-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/filter-records" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-filter-records",
- "summary" : "POST /api/ee/metabot-tools/filter-records",
- "description" : "Apply filters to records from a data source (query, report, or table).",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
- },
+ "description" : "Must be a string like 2020-04 or 2222-11."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
"4XX" : {
"description" : "Client error response"
},
@@ -29504,75 +28695,45 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter-records-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/logs" ]
}
},
- "/api/ee/metabot-tools/generate-insights" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-generate-insights",
- "summary" : "POST /api/ee/metabot-tools/generate-insights",
- "description" : "Generate insights.",
- "parameters" : [ ],
+ "/api/ee/permission_debug" : {
+ "get" : {
+ "operationId" : "get-api-ee-permission_debug",
+ "summary" : "GET /api/ee/permission_debug",
+ "description" : "This endpoint expects a `user_id`, a `model_id` to debug permissions against, and `action_type`.\n The type of model we are debugging against is inferred by the `action_type`.\n\n It will return:\n - `decision`: The overall permission decision (\"allow\", \"denied\", or \"limited\")\n - `model-type`: The type of model being checked (e.g., \"question\")\n - `model-id`: The ID of the model being checked\n - `segment`: A set of segmentation types applied (e.g., \"sandboxed\", \"impersonated\", \"routed\")\n - `message`: A sequence of strings explaining the decision\n - `data`: A map containing details about permissions (table or collection names to group names)\n - `suggestions`: A map of group IDs to group names that could provide access\n\n Example requests:\n - Check if user can read a card: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/read`\n - Check if user can query a card: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/query`\n - Check if user can download data: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/download-data`\n\n Example responses:\n - Allowed access:\n ```json\n {\n \"decision\": \"allow\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User has permission to read this card\"],\n \"data\": {},\n \"suggestions\": {}\n }\n ```\n - Denied access with blocked table:\n ```json\n {\n \"decision\": \"denied\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User does not have permission to query this card\"],\n \"data\": {\"sample-db.PUBLIC.ORDERS\": [\"All Users\"]},\n \"suggestions\": {}\n }\n ```\n - Limited access:\n ```json\n {\n \"decision\": \"limited\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User has permission to download some data from this card\"],\n \"data\": {},\n \"suggestions\": {}\n }\n ```",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "user_id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }, {
+ "in" : "query",
+ "name" : "model_id",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "action_type",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "card/read", "card/query", "card/download-data" ]
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "output" : {
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "reactions" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabot.reaction.redirect"
- }
- }
- },
- "required" : [ "output", "reactions", "conversation_id" ]
+ "$ref" : "#/components/schemas/metabase-enterprise.permission-debug.impl.perm-debug-info"
}
}
}
@@ -29584,66 +28745,31 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.generate-insights-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/permission_debug" ]
}
},
- "/api/ee/metabot-tools/get-current-user" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-get-current-user",
- "summary" : "POST /api/ee/metabot-tools/get-current-user",
- "description" : "Get information about user that started the conversation.",
+ "/api/ee/remote-sync/branches" : {
+ "get" : {
+ "operationId" : "get-api-ee-remote-sync-branches",
+ "summary" : "GET /api/ee/remote-sync/branches",
+ "description" : "Get list of branches from the configured source.\n\n Returns a JSON object with branch names under the :items key.\n\n Requires superuser permissions.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
+ "items" : {
+ "type" : "array",
+ "items" : {
"type" : "string"
- }, {
- "type" : "null"
- } ]
+ }
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "items" ]
}
}
}
@@ -29655,47 +28781,31 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-dashboard-details" : {
+ "/api/ee/remote-sync/create-branch" : {
"post" : {
- "operationId" : "post-api-ee-metabot-tools-get-dashboard-details",
- "summary" : "POST /api/ee/metabot-tools/get-dashboard-details",
- "description" : "Get information about a given dashboard.",
+ "operationId" : "post-api-ee-remote-sync-create-branch",
+ "summary" : "POST /api/ee/remote-sync/create-branch",
+ "description" : "Create a new branch from the current remote-sync branch and switches the current remote-sync branch to it.\n Requires superuser permissions.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "message" : {
+ "type" : "string"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "status" : {
+ "type" : "string"
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "status", "message" ]
}
}
}
@@ -29711,62 +28821,112 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-dashboard-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
+ "name" : {
"type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "minLength" : 1
}
},
- "required" : [ "arguments", "conversation_id" ]
+ "required" : [ "name" ]
}
}
}
},
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-document-details" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-get-document-details",
- "summary" : "POST /api/ee/metabot-tools/get-document-details",
- "description" : "Get information about a given document.",
+ "/api/ee/remote-sync/current-task" : {
+ "get" : {
+ "operationId" : "get-api-ee-remote-sync-current-task",
+ "summary" : "GET /api/ee/remote-sync/current-task",
+ "description" : "Get the current sync task",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "progress" : {
+ "oneOf" : [ {
+ "type" : "number",
+ "minimum" : 0.0,
+ "maximum" : 1.0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "conflicts" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_progress_report_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "started_at" : { },
+ "ended_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "initiated_by" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "cancelled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "running", "successful", "errored", "cancelled", "timed-out", "conflict" ]
+ },
+ "error_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "sync_task_type" : {
+ "type" : "string",
+ "enum" : [ "import", "export" ]
+ },
+ "version" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
+ "required" : [ "id", "sync_task_type", "progress", "started_at", "status" ]
+ }, {
+ "type" : "null"
+ } ]
}
}
}
@@ -29778,58 +28938,88 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-document-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-metric-details" : {
+ "/api/ee/remote-sync/current-task/cancel" : {
"post" : {
- "operationId" : "post-api-ee-metabot-tools-get-metric-details",
- "summary" : "POST /api/ee/metabot-tools/get-metric-details",
- "description" : "Get information about a given metric.",
+ "operationId" : "post-api-ee-remote-sync-current-task-cancel",
+ "summary" : "POST /api/ee/remote-sync/current-task/cancel",
+ "description" : "Cancels the current task if one is running",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
+ "progress" : {
+ "oneOf" : [ {
+ "type" : "number",
+ "minimum" : 0.0,
+ "maximum" : 1.0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "conflicts" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_progress_report_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "started_at" : { },
+ "ended_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "initiated_by" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "cancelled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
"type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "enum" : [ "running", "successful", "errored", "cancelled", "timed-out", "conflict" ]
},
- "profile_id" : {
+ "error_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "sync_task_type" : {
+ "type" : "string",
+ "enum" : [ "import", "export" ]
+ },
+ "version" : {
"oneOf" : [ {
"type" : "string"
}, {
@@ -29837,7 +29027,7 @@
} ]
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "id", "sync_task_type", "progress", "started_at", "status" ]
}
}
}
@@ -29849,66 +29039,107 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-metric-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-query-details" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-get-query-details",
- "summary" : "POST /api/ee/metabot-tools/get-query-details",
- "description" : "Get information about a given query.",
+ "/api/ee/remote-sync/dirty" : {
+ "get" : {
+ "operationId" : "get-api-ee-remote-sync-dirty",
+ "summary" : "GET /api/ee/remote-sync/dirty",
+ "description" : "Return all models with changes that have not been pushed to the remote sync source in any\n remote-synced collection.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "dirty" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "table_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "model" : {
+ "type" : "string"
+ },
+ "authority_level" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "query_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "display" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "sync_status" : {
+ "type" : "string"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "model", "sync_status" ]
+ }
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "dirty" ]
}
}
}
@@ -29920,66 +29151,32 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-query-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-report-details" : {
+ "/api/ee/remote-sync/export" : {
"post" : {
- "operationId" : "post-api-ee-metabot-tools-get-report-details",
- "summary" : "POST /api/ee/metabot-tools/get-report-details",
- "description" : "Get information about a given report.",
+ "operationId" : "post-api-ee-remote-sync-export",
+ "summary" : "POST /api/ee/remote-sync/export",
+ "description" : "Export the current state of the Remote Sync collection to a Source.\n\n This endpoint will:\n - Fetch the latest changes from the source\n - Create a branch or subdirectory (depending on source support)\n If no branch is supplied, use the configured export branch\n - Export the Remote Sync collection via serialization to the branch or subdirectory\n - Commit the changes if possible\n - Sync to the source if possible\n\n Requires superuser permissions.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "message" : {
+ "type" : "string"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "task_id" : {
+ "type" : "integer",
+ "minimum" : 1
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "message", "task_id" ]
}
}
}
@@ -29991,69 +29188,52 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-report-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-snippet-details" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-get-snippet-details",
- "summary" : "POST /api/ee/metabot-tools/get-snippet-details",
- "description" : "Get the content of a single SQL snippet.",
- "parameters" : [ ],
+ "/api/ee/remote-sync/has-remote-changes" : {
+ "get" : {
+ "operationId" : "get-api-ee-remote-sync-has-remote-changes",
+ "summary" : "GET /api/ee/remote-sync/has-remote-changes",
+ "description" : "Check if there are new changes on the remote branch that can be pulled.\n Uses in-memory caching (configurable TTL via remote-sync-check-changes-cache-ttl-seconds setting).\n\n Returns:\n - has_changes: true if remote version differs from last imported version, or if never imported\n - remote_version: current Git SHA on remote branch\n - local_version: Git SHA of last successful import (nil if never imported)\n - cached: true if result was served from cache",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "force-refresh",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "cached" : {
+ "type" : "boolean"
},
- "profile_id" : {
+ "has_changes" : {
+ "type" : "boolean"
+ },
+ "local_version" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "structured_output" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.full-snippet"
+ "remote_version" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "structured_output", "conversation_id" ]
+ "required" : [ "has_changes", "remote_version", "local_version", "cached" ]
}
}
}
@@ -30065,124 +29245,43 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-snippet-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-snippets" : {
+ "/api/ee/remote-sync/import" : {
"post" : {
- "operationId" : "post-api-ee-metabot-tools-get-snippets",
- "summary" : "POST /api/ee/metabot-tools/get-snippets",
- "description" : "Get a list of all known SQL snippets.",
+ "operationId" : "post-api-ee-remote-sync-import",
+ "summary" : "POST /api/ee/remote-sync/import",
+ "description" : "Import Metabase content from configured Remote Sync source.\n\n This endpoint will:\n - Fetch the latest changes from the configured source\n - Load the updated content using the serialization/deserialization system\n\n If `force=false` (default) and there are unsaved changes in the Remote Sync collection,\n the import returns a 400 response.\n\n Requires superuser permissions.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
+ "message" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "structured_output" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.basic-snippet"
- }
- }
- },
- "required" : [ "structured_output", "conversation_id" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/get-table-details" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-get-table-details",
- "summary" : "POST /api/ee/metabot-tools/get-table-details",
- "description" : "Get information about a given table or model.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "status" : {
+ "const" : "success"
},
- "profile_id" : {
+ "task_id" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "status", "task_id" ]
}
}
}
@@ -30198,62 +29297,42 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-table-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
+ "branch" : {
"type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "minLength" : 1
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "force" : {
+ "type" : "boolean"
}
- },
- "required" : [ "arguments", "conversation_id" ]
+ }
}
}
}
},
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-tables" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-get-tables",
- "summary" : "POST /api/ee/metabot-tools/get-tables",
- "description" : "Get information about the tables in a given database.",
+ "/api/ee/remote-sync/is-dirty" : {
+ "get" : {
+ "operationId" : "get-api-ee-remote-sync-is-dirty",
+ "summary" : "GET /api/ee/remote-sync/is-dirty",
+ "description" : "Check if any remote-synced collection or collection item has local changes that have not been pushed\n to the remote sync source.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "is_dirty" : {
+ "type" : "boolean"
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "is_dirty" ]
}
}
}
@@ -30265,66 +29344,32 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-tables-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-transform-details" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-get-transform-details",
- "summary" : "POST /api/ee/metabot-tools/get-transform-details",
- "description" : "Get information about a transform.",
+ "/api/ee/remote-sync/settings" : {
+ "put" : {
+ "operationId" : "put-api-ee-remote-sync-settings",
+ "summary" : "PUT /api/ee/remote-sync/settings",
+ "description" : "Update Remote Sync related settings. You must be a superuser to do this.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "success" : {
+ "type" : "boolean"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "task_id" : {
+ "type" : "integer",
+ "minimum" : 1
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "success" ]
}
}
}
@@ -30340,62 +29385,95 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-transform-details-arguments"
+ "collections" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "boolean"
+ }
+ }, {
+ "type" : "null"
+ } ]
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "remote-sync-auto-import" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "profile_id" : {
+ "remote-sync-branch" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "remote-sync-token" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "remote-sync-transforms" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "remote-sync-type" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "read-only", "read-write" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "remote-sync-url" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
}
- },
- "required" : [ "arguments", "conversation_id" ]
+ }
}
}
}
},
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-transform-python-library-details" : {
+ "/api/ee/remote-sync/stash" : {
"post" : {
- "operationId" : "post-api-ee-metabot-tools-get-transform-python-library-details",
- "summary" : "POST /api/ee/metabot-tools/get-transform-python-library-details",
- "description" : "Get information about a Python library by path.",
+ "operationId" : "post-api-ee-remote-sync-stash",
+ "summary" : "POST /api/ee/remote-sync/stash",
+ "description" : "Stashes changes to a new branch, and changes the current branch to it.\n Requires superuser permissions.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "message" : {
+ "type" : "string"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "status" : {
+ "type" : "string"
+ },
+ "task_id" : {
+ "type" : "integer",
+ "minimum" : 1
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "status", "message", "task_id" ]
}
}
}
@@ -30411,62 +29489,38 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-transform-python-library-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
+ "message" : {
"type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "minLength" : 1
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "new_branch" : {
+ "type" : "string",
+ "minLength" : 1
}
},
- "required" : [ "arguments", "conversation_id" ]
+ "required" : [ "new_branch", "message" ]
}
}
}
},
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/metabot-tools/get-transforms" : {
+ "/api/ee/replacement/check-replace-source" : {
"post" : {
- "operationId" : "post-api-ee-metabot-tools-get-transforms",
- "summary" : "POST /api/ee/metabot-tools/get-transforms",
- "description" : "Get a list of all known transforms.",
+ "operationId" : "post-api-ee-replacement-check-replace-source",
+ "summary" : "POST /api/ee/replacement/check-replace-source",
+ "description" : "Check whether a source entity can be replaced by a target entity. Returns compatibility\n errors describing column mismatches, type mismatches, primary key mismatches, and foreign\n key mismatches.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.check-replace-source-response"
}
}
}
@@ -30482,43 +29536,58 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"
+ "type" : "object",
+ "properties" : {
+ "source_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "source_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ },
+ "target_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "target_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ }
+ },
+ "required" : [ "source_entity_id", "source_entity_type", "target_entity_id", "target_entity_type" ]
}
}
}
},
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/replacement" ]
}
},
- "/api/ee/metabot-tools/query-datasource" : {
+ "/api/ee/replacement/replace-model-with-transform" : {
"post" : {
- "operationId" : "post-api-ee-metabot-tools-query-datasource",
- "summary" : "POST /api/ee/metabot-tools/query-datasource",
- "description" : "Construct a query from a model or table data source.",
+ "operationId" : "post-api-ee-replacement-replace-model-with-transform",
+ "summary" : "POST /api/ee/replacement/replace-model-with-transform",
+ "description" : "Create a transform from a model, execute it, and replace all usages of the model\n with the output table. Un-persists the model and converts it to a saved question.\n Returns 202 with a run_id for polling.\n\n If there is an error during the transform execution, no replacement will be\n performed and the model will remain unchanged.\n\n If there is an error during the source swap, the transform and the output\n table will be retained, and the model will remain unchanged. We cannot delete\n the transform or the output table because they can be used by other queries at\n this point.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "body" : {
+ "type" : "object",
+ "properties" : {
+ "run_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
+ }
+ },
+ "required" : [ "run_id" ],
+ "additionalProperties" : false
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "status" : {
+ "const" : 202
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "status", "body" ]
}
}
}
@@ -30534,62 +29603,74 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.query-datasource-arguments"
+ "card_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "target_collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ }, {
+ "type" : "null"
+ } ]
},
- "profile_id" : {
+ "transform_name" : {
+ "type" : "string"
+ },
+ "transform_tag_ids" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
}, {
"type" : "null"
} ]
+ },
+ "transform_target" : {
+ "type" : "object",
+ "properties" : { }
}
},
- "required" : [ "arguments", "conversation_id" ]
+ "required" : [ "card_id", "transform_name", "transform_target" ]
}
}
}
},
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/replacement" ]
}
},
- "/api/ee/metabot-tools/query-metric" : {
+ "/api/ee/replacement/replace-source" : {
"post" : {
- "operationId" : "post-api-ee-metabot-tools-query-metric",
- "summary" : "POST /api/ee/metabot-tools/query-metric",
- "description" : "Construct a query from a metric.",
+ "operationId" : "post-api-ee-replacement-replace-source",
+ "summary" : "POST /api/ee/replacement/replace-source",
+ "description" : "Replace all usages of a source entity with a target entity asynchronously.\n Returns 202 with a run_id for polling. Returns 409 if a replacement is already running.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "body" : {
+ "type" : "object",
+ "properties" : {
+ "run_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
+ }
+ },
+ "required" : [ "run_id" ],
+ "additionalProperties" : false
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "status" : {
+ "const" : 202
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "status", "body" ]
}
}
}
@@ -30605,62 +29686,130 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.query-metric-arguments"
+ "source_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "source_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "target_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "target_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
}
},
- "required" : [ "arguments", "conversation_id" ]
+ "required" : [ "source_entity_id", "source_entity_type", "target_entity_id", "target_entity_type" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/replacement" ]
+ }
+ },
+ "/api/ee/replacement/runs" : {
+ "get" : {
+ "operationId" : "get-api-ee-replacement-runs",
+ "summary" : "GET /api/ee/replacement/runs",
+ "description" : "List replacement runs, optionally filtered by is-active.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "is-active",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run"
+ }
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/replacement" ]
+ }
+ },
+ "/api/ee/replacement/runs/{id}" : {
+ "get" : {
+ "operationId" : "get-api-ee-replacement-runs-id",
+ "summary" : "GET /api/ee/replacement/runs/{id}",
+ "description" : "Get the status of a source replacement run.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run"
+ }
}
}
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/replacement" ]
}
},
- "/api/ee/metabot-tools/query-model" : {
+ "/api/ee/replacement/runs/{id}/cancel" : {
"post" : {
- "operationId" : "post-api-ee-metabot-tools-query-model",
- "summary" : "POST /api/ee/metabot-tools/query-model",
- "description" : "Construct a query from a model.",
- "parameters" : [ ],
+ "operationId" : "post-api-ee-replacement-runs-id-cancel",
+ "summary" : "POST /api/ee/replacement/runs/{id}/cancel",
+ "description" : "Cancel a running source replacement.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "success" : {
+ "type" : "boolean"
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "success" ]
}
}
}
@@ -30672,69 +29821,202 @@
"description" : "Server error response"
}
},
+ "tags" : [ "/api/ee/replacement" ]
+ }
+ },
+ "/api/ee/scim/api_key" : {
+ "get" : {
+ "operationId" : "get-api-ee-scim-api_key",
+ "summary" : "GET /api/ee/scim/api_key",
+ "description" : "Fetch the SCIM API key if one exists. Does *not* return an unmasked key, since we don't have access\n to that after it is created.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/scim" ]
+ },
+ "post" : {
+ "operationId" : "post-api-ee-scim-api_key",
+ "summary" : "POST /api/ee/scim/api_key",
+ "description" : "Create a new SCIM API key, or refresh one that already exists. When called for the first time,\n this is equivalent to enabling SCIM.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/scim" ]
+ }
+ },
+ "/api/ee/scim/v2/Groups" : {
+ "get" : {
+ "operationId" : "get-api-ee-scim-v2-Groups",
+ "summary" : "GET /api/ee/scim/v2/Groups",
+ "description" : "Fetch a list of groups.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "startIndex",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "count",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "filter",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
+ "post" : {
+ "operationId" : "post-api-ee-scim-v2-Groups",
+ "summary" : "POST /api/ee/scim/v2/Groups",
+ "description" : "Create a single group, and populates it if necessary.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.query-model-arguments"
+ "displayName" : {
+ "type" : "string",
+ "minLength" : 1
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
+ "id" : {
"type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "minLength" : 1
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "members" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "$ref" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "value" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "value" ]
+ }
+ },
+ "schemas" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "minLength" : 1
+ }
}
},
- "required" : [ "arguments", "conversation_id" ]
+ "required" : [ "schemas", "displayName" ]
}
}
}
},
- "tags" : [ "/api/ee/metabot-tools" ]
+ "tags" : [ "/api/ee/scim/v2" ]
}
},
- "/api/ee/metabot-tools/search" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-search",
- "summary" : "POST /api/ee/metabot-tools/search",
- "description" : "Enhanced search with term and semantic queries using Reciprocal Rank Fusion.",
+ "/api/ee/scim/v2/Groups/{id}" : {
+ "get" : {
+ "operationId" : "get-api-ee-scim-v2-Groups-id",
+ "summary" : "GET /api/ee/scim/v2/Groups/{id}",
+ "description" : "Fetch a single group.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
+ "put" : {
+ "operationId" : "put-api-ee-scim-v2-Groups-id",
+ "summary" : "PUT /api/ee/scim/v2/Groups/{id}",
+ "description" : "Update a group.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -30747,65 +30029,122 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.search-arguments"
+ "displayName" : {
+ "type" : "string",
+ "minLength" : 1
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
+ "id" : {
"type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "minLength" : 1
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "members" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "$ref" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "value" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "value" ]
+ }
+ },
+ "schemas" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "minLength" : 1
+ }
}
},
- "required" : [ "conversation_id" ]
+ "required" : [ "schemas", "displayName" ]
}
}
}
- },
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/search_v2" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-tools-search_v2",
- "summary" : "POST /api/ee/metabot-tools/search_v2",
- "description" : "Enhanced search with term and semantic queries using Reciprocal Rank Fusion. This is identical to /search, but\n duplicated in order to add a new capability to AI service that indicates that Metabot can search transforms. The\n /search endpoint is kept around for backward compatibility.",
- "parameters" : [ ],
+ },
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-ee-scim-v2-Groups-id",
+ "summary" : "DELETE /api/ee/scim/v2/Groups/{id}",
+ "description" : "Delete a group.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/scim/v2" ]
+ }
+ },
+ "/api/ee/scim/v2/Users" : {
+ "get" : {
+ "operationId" : "get-api-ee-scim-v2-Users",
+ "summary" : "GET /api/ee/scim/v2/Users",
+ "description" : "Fetch a list of users.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "startIndex",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "count",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "filter",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -30814,42 +30153,12 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "type" : "object",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.search-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-v3/agent-streaming" : {
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
"post" : {
- "operationId" : "post-api-ee-metabot-v3-agent-streaming",
- "summary" : "POST /api/ee/metabot-v3/agent-streaming",
- "description" : "Send a chat message to the LLM via the AI Proxy.",
+ "operationId" : "post-api-ee-scim-v2-Users",
+ "summary" : "POST /api/ee/scim/v2/Users",
+ "description" : "Create a single user.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -30868,56 +30177,125 @@
"schema" : {
"type" : "object",
"properties" : {
- "context" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.context.context"
+ "active" : {
+ "type" : "boolean"
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
+ "emails" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "primary" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "value" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "value" ]
+ }
+ },
+ "groups" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "$ref" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "display" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "value" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "value", "display" ]
+ }
+ },
+ "id" : {
"type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ "minLength" : 1
},
- "debug" : {
+ "locale" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string",
+ "minLength" : 1
}, {
"type" : "null"
} ]
},
- "history" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.client.schema.messages"
- }, {
- "type" : "null"
- } ]
+ "name" : {
+ "type" : "object",
+ "properties" : {
+ "familyName" : {
+ "type" : "string"
+ },
+ "givenName" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "givenName", "familyName" ]
},
- "message" : {
+ "schemas" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "userName" : {
"type" : "string",
"minLength" : 1
- },
- "metabot_id" : {
- "type" : "string"
- },
- "profile_id" : {
- "type" : "string"
- },
- "state" : {
- "type" : "object",
- "properties" : { }
}
},
- "required" : [ "message", "context", "conversation_id", "history", "state" ]
+ "required" : [ "schemas", "userName", "name", "emails" ]
}
}
}
},
- "tags" : [ "/api/ee/metabot-v3" ]
+ "tags" : [ "/api/ee/scim/v2" ]
}
},
- "/api/ee/metabot-v3/document/generate-content" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-v3-document-generate-content",
- "summary" : "POST /api/ee/metabot-v3/document/generate-content",
- "description" : "Create a new piece of content to insert into the document.",
+ "/api/ee/scim/v2/Users/{id}" : {
+ "get" : {
+ "operationId" : "get-api-ee-scim-v2-Users-id",
+ "summary" : "GET /api/ee/scim/v2/Users/{id}",
+ "description" : "Fetch a single user.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
+ "put" : {
+ "operationId" : "put-api-ee-scim-v2-Users-id",
+ "summary" : "PUT /api/ee/scim/v2/Users/{id}",
+ "description" : "Update a user.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -30936,100 +30314,109 @@
"schema" : {
"type" : "object",
"properties" : {
- "instructions" : {
+ "active" : {
+ "type" : "boolean"
+ },
+ "emails" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "primary" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "value" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "value" ]
+ }
+ },
+ "groups" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "$ref" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "display" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "value" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "value", "display" ]
+ }
+ },
+ "id" : {
"type" : "string",
"minLength" : 1
},
- "references" : {
- "description" : "Value must be a map.",
+ "locale" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
"type" : "object",
- "properties" : { }
+ "properties" : {
+ "familyName" : {
+ "type" : "string"
+ },
+ "givenName" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "givenName", "familyName" ]
+ },
+ "schemas" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "userName" : {
+ "type" : "string",
+ "minLength" : 1
}
},
- "required" : [ "instructions" ]
+ "required" : [ "schemas", "userName", "name", "emails" ]
}
}
}
},
- "tags" : [ "/api/ee/metabot-v3/document" ]
- }
- },
- "/api/ee/metabot-v3/document/native-generate-content" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-v3-document-native-generate-content",
- "summary" : "POST /api/ee/metabot-v3/document/native-generate-content",
- "description" : "Create a new piece of content to insert into the document using the native Clojure agent.",
- "parameters" : [ ],
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
+ "patch" : {
+ "operationId" : "patch-api-ee-scim-v2-Users-id",
+ "summary" : "PATCH /api/ee/scim/v2/Users/{id}",
+ "description" : "Activate or deactivate a user. Supports specific replace operations, but not arbitrary patches.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "draft_card" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "dataset_query" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "parameters" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }
- }, {
- "type" : "null"
- } ]
- },
- "visualization_settings" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
- }
- },
- "required" : [ "name", "dataset_query", "database_id", "parameters", "visualization_settings" ]
- }, {
- "type" : "null"
- } ]
- },
- "error" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "draft_card", "error", "description" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -31044,29 +30431,58 @@
"schema" : {
"type" : "object",
"properties" : {
- "instructions" : {
- "type" : "string",
- "minLength" : 1
+ "Operations" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "op" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "value" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "anyOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "boolean"
+ } ]
+ }
+ }, {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "boolean"
+ } ]
+ }
+ },
+ "required" : [ "op", "value" ]
+ }
},
- "references" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "schemas" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "minLength" : 1
+ }
}
},
- "required" : [ "instructions" ]
+ "required" : [ "schemas", "Operations" ]
}
}
}
},
- "tags" : [ "/api/ee/metabot-v3/document" ]
+ "tags" : [ "/api/ee/scim/v2" ]
}
},
- "/api/ee/metabot-v3/feedback" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-v3-feedback",
- "summary" : "POST /api/ee/metabot-v3/feedback",
- "description" : "Proxy Metabot feedback to Harbormaster, adding the premium embedding token.",
+ "/api/ee/semantic-search/status" : {
+ "get" : {
+ "operationId" : "get-api-ee-semantic-search-status",
+ "summary" : "GET /api/ee/semantic-search/status",
+ "description" : "Fetch the indexing status of the currently active semantic search index table.\n\n Returns a map with keys:\n :indexed_count <number of indexed items>\n :total_est <estimated total number of items to index>\n\n If no index is active, returns an empty map.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -31079,25 +30495,108 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : { }
+ "tags" : [ "/api/ee/semantic-search" ]
+ }
+ },
+ "/api/ee/serialization/export" : {
+ "post" : {
+ "operationId" : "post-api-ee-serialization-export",
+ "summary" : "POST /api/ee/serialization/export",
+ "description" : "Serialize and retrieve Metabase instance.\n\n Outputs `.tar.gz` file with serialization results and an `export.log` file.\n On error outputs serialization logs directly.",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "dirname",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : "name of directory and archive file (default: `<instance-name>-<YYYY-MM-dd_HH-mm>`)"
+ }, {
+ "in" : "query",
+ "name" : "collection",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "string",
+ "pattern" : "^.{21}$"
+ }, {
+ "type" : "string",
+ "pattern" : "^eid:.{21}$"
+ } ]
}
- }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : "collections' db ids/entity-ids to serialize"
+ }, {
+ "in" : "query",
+ "name" : "all_collections",
+ "required" : true,
+ "schema" : {
+ "default" : true,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "settings",
+ "required" : true,
+ "schema" : {
+ "default" : true,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "data_model",
+ "required" : true,
+ "schema" : {
+ "default" : true,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "field_values",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "database_secrets",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "continue_on_error",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
}
- },
- "tags" : [ "/api/ee/metabot-v3" ]
- }
- },
- "/api/ee/metabot-v3/metabot" : {
- "get" : {
- "operationId" : "get-api-ee-metabot-v3-metabot",
- "summary" : "GET /api/ee/metabot-v3/metabot",
- "description" : "List configured metabot instances",
- "parameters" : [ ],
+ }, {
+ "in" : "query",
+ "name" : "full_stacktrace",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31109,47 +30608,37 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "tags" : [ "/api/ee/serialization" ]
}
},
- "/api/ee/metabot-v3/metabot/{id}" : {
- "get" : {
- "operationId" : "get-api-ee-metabot-v3-metabot-id",
- "summary" : "GET /api/ee/metabot-v3/metabot/{id}",
- "description" : "Retrieve one metabot instance",
+ "/api/ee/serialization/import" : {
+ "post" : {
+ "operationId" : "post-api-ee-serialization-import",
+ "summary" : "POST /api/ee/serialization/import",
+ "description" : "Deserialize Metabase instance from an archive generated by /export.\n\n Parameters:\n - `file`: archive encoded as `multipart/form-data` (required).\n\n Returns logs of deserialization.",
"parameters" : [ {
- "in" : "path",
- "name" : "id",
+ "in" : "query",
+ "name" : "continue_on_error",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "default" : false,
+ "type" : "boolean"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ }, {
+ "in" : "query",
+ "name" : "full_stacktrace",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
}
- },
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
- },
- "put" : {
- "operationId" : "put-api-ee-metabot-v3-metabot-id",
- "summary" : "PUT /api/ee/metabot-v3/metabot/{id}",
- "description" : "Update a metabot instance",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
+ }, {
+ "in" : "query",
+ "name" : "reindex",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "default" : true,
+ "type" : "boolean"
}
} ],
"responses" : {
@@ -31165,65 +30654,91 @@
},
"requestBody" : {
"content" : {
- "application/json" : {
+ "multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
- "collection_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "use_verified_content" : {
- "type" : "boolean"
+ "file" : {
+ "description" : ".tgz with serialization data",
+ "type" : "object",
+ "properties" : {
+ "content-type" : {
+ "type" : "string"
+ },
+ "filename" : {
+ "type" : "string"
+ },
+ "size" : {
+ "type" : "integer"
+ },
+ "tempfile" : { }
+ },
+ "required" : [ "content-type", "filename", "size", "tempfile" ],
+ "additionalProperties" : false
}
},
- "additionalProperties" : false
+ "required" : [ "file" ]
}
}
}
},
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "tags" : [ "/api/ee/serialization" ]
}
},
- "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions" : {
+ "/api/ee/stale/{id}" : {
"get" : {
- "operationId" : "get-api-ee-metabot-v3-metabot-id-prompt-suggestions",
- "summary" : "GET /api/ee/metabot-v3/metabot/{id}/prompt-suggestions",
- "description" : "Return the prompt suggestions for the metabot instance with `id`.",
+ "operationId" : "get-api-ee-stale-id",
+ "summary" : "GET /api/ee/stale/{id}",
+ "description" : "A flexible endpoint that returns stale entities, in the same shape as collections/items, with the following options:\n - `before_date` - only return entities that were last edited before this date (default: 6 months ago)\n - `is_recursive` - if true, return entities from all children of the collection, not just the direct children (default: false)\n - `sort_column` - the column to sort by (default: name)\n - `sort_direction` - the direction to sort by (default: asc)",
"parameters" : [ {
"in" : "path",
"name" : "id",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "const" : "root"
+ } ]
}
}, {
"in" : "query",
- "name" : "sample",
+ "name" : "before_date",
"required" : false,
"schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "is_recursive",
+ "required" : true,
+ "schema" : {
+ "default" : false,
"type" : "boolean"
}
}, {
"in" : "query",
- "name" : "model",
- "required" : false,
+ "name" : "sort_column",
+ "required" : true,
"schema" : {
+ "default" : "name",
"type" : "string",
- "enum" : [ "metric", "model" ]
+ "enum" : [ "name", "last_used_at" ]
}
}, {
"in" : "query",
- "name" : "model_id",
- "required" : false,
+ "name" : "sort_direction",
+ "required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "default" : "asc",
+ "type" : "string",
+ "enum" : [ "asc", "desc" ]
}
} ],
"responses" : {
@@ -31237,24 +30752,94 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "tags" : [ "/api/ee/stale" ]
+ }
+ },
+ "/api/ee/support-access-grant" : {
+ "post" : {
+ "operationId" : "post-api-ee-support-access-grant",
+ "summary" : "POST /api/ee/support-access-grant",
+ "description" : "Create a new support access grant.\n\n Requires superuser permissions. Only one active grant can exist at a time.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.create-grant-request"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/support-access-grant" ]
},
- "delete" : {
- "operationId" : "delete-api-ee-metabot-v3-metabot-id-prompt-suggestions",
- "summary" : "DELETE /api/ee/metabot-v3/metabot/{id}/prompt-suggestions",
- "description" : "Delete all prompt suggestions for the metabot instance with `id`.",
+ "get" : {
+ "operationId" : "get-api-ee-support-access-grant",
+ "summary" : "GET /api/ee/support-access-grant",
+ "description" : "List support access grants with optional filtering and pagination.\n\n Requires superuser permissions.\n\n Query parameters:\n - ticket-number: Filter by ticket number\n - user-id: Filter by user who created the grant\n - include-revoked: Include revoked grants (default false)",
"parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
+ "in" : "query",
+ "name" : "ticket-number",
+ "required" : false,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "user-id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include-revoked",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.list-grants-response"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -31263,26 +30848,25 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "tags" : [ "/api/ee/support-access-grant" ]
}
},
- "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/regenerate" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-v3-metabot-id-prompt-suggestions-regenerate",
- "summary" : "POST /api/ee/metabot-v3/metabot/{id}/prompt-suggestions/regenerate",
- "description" : "Remove any existing prompt suggestions for the Metabot instance with `id` and generate new ones.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- }
- } ],
+ "/api/ee/support-access-grant/current" : {
+ "get" : {
+ "operationId" : "get-api-ee-support-access-grant-current",
+ "summary" : "GET /api/ee/support-access-grant/current",
+ "description" : "Get the currently active support access grant, if one exists.\n\n Requires superuser permissions.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.current-grant-response"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -31291,14 +30875,14 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "tags" : [ "/api/ee/support-access-grant" ]
}
},
- "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}" : {
- "delete" : {
- "operationId" : "delete-api-ee-metabot-v3-metabot-id-prompt-suggestions-prompt-id",
- "summary" : "DELETE /api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}",
- "description" : "Delete the prompt suggestion with ID `prompt-id` for the metabot instance with `id`.",
+ "/api/ee/support-access-grant/{id}/revoke" : {
+ "put" : {
+ "operationId" : "put-api-ee-support-access-grant-id-revoke",
+ "summary" : "PUT /api/ee/support-access-grant/{id}/revoke",
+ "description" : "Revoke an existing support access grant.\n\n Requires superuser permissions. Any admin can revoke any grant.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -31306,19 +30890,19 @@
"schema" : {
"type" : "integer",
"minimum" : 1
- }
- }, {
- "in" : "path",
- "name" : "prompt-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- }
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -31327,14 +30911,14 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "tags" : [ "/api/ee/support-access-grant" ]
}
},
- "/api/ee/metabot-v3/slack/events" : {
+ "/api/ee/tenant" : {
"post" : {
- "operationId" : "post-api-ee-metabot-v3-slack-events",
- "summary" : "POST /api/ee/metabot-v3/slack/events",
- "description" : "Respond to activities in Slack",
+ "operationId" : "post-api-ee-tenant",
+ "summary" : "POST /api/ee/tenant",
+ "description" : "Create a new Tenant",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -31344,23 +30928,45 @@
"schema" : {
"type" : "object",
"properties" : {
- "body" : {
- "type" : "string"
- },
- "headers" : {
- "type" : "object",
- "properties" : {
- "Content-Type" : {
- "const" : "text/plain"
+ "attributes" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
}
- },
- "required" : [ "Content-Type" ]
+ }, {
+ "type" : "null"
+ } ]
},
- "status" : {
- "const" : 200
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "type" : "string",
+ "pattern" : "^[-_a-z0-9]{1,255}$"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}
},
- "required" : [ "status", "headers", "body" ]
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
+ "additionalProperties" : false
}
}
}
@@ -31376,62 +30982,108 @@
"content" : {
"application/json" : {
"schema" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "challenge" : {
- "type" : "string"
- },
- "type" : {
- "const" : "url_verification"
- }
- },
- "required" : [ "type", "challenge" ]
- }, {
- "type" : "object",
- "properties" : {
- "event" : {
+ "type" : "object",
+ "properties" : {
+ "attributes" : {
+ "oneOf" : [ {
"type" : "object",
- "properties" : {
- "event_ts" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "type", "event_ts" ]
- },
- "type" : {
- "const" : "event_callback"
- }
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "type", "event" ]
- }, {
- "type" : "object",
- "properties" : {
- "type" : {
- "type" : "string"
- }
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
},
- "required" : [ "type" ]
- } ]
+ "slug" : {
+ "description" : "invalid slug",
+ "type" : "string",
+ "pattern" : "^[-_a-z0-9]{1,255}$"
+ }
+ },
+ "required" : [ "name", "slug" ],
+ "additionalProperties" : false
}
}
}
},
- "tags" : [ "/api/ee/metabot-v3/slack" ]
- }
- },
- "/api/ee/metabot-v3/slack/interactive" : {
- "post" : {
- "operationId" : "post-api-ee-metabot-v3-slack-interactive",
- "summary" : "POST /api/ee/metabot-v3/slack/interactive",
- "description" : "Handle interactive payloads from Slack (button clicks, modal submissions).",
- "parameters" : [ ],
+ "tags" : [ "/api/ee/tenant" ]
+ },
+ "get" : {
+ "operationId" : "get-api-ee-tenant",
+ "summary" : "GET /api/ee/tenant",
+ "description" : "Get all tenants",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "status",
+ "required" : true,
+ "schema" : {
+ "default" : "all",
+ "type" : "string",
+ "enum" : [ "all", "deactivated", "active" ]
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "attributes" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "type" : "string",
+ "pattern" : "^[-_a-z0-9]{1,255}$"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
+ "additionalProperties" : false
+ }
+ }
+ },
+ "required" : [ "data" ],
+ "additionalProperties" : false
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -31440,15 +31092,24 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/metabot-v3/slack" ]
+ "tags" : [ "/api/ee/tenant" ]
}
},
- "/api/ee/metabot-v3/slack/settings" : {
+ "/api/ee/tenant/{id}" : {
"put" : {
- "operationId" : "put-api-ee-metabot-v3-slack-settings",
- "summary" : "PUT /api/ee/metabot-v3/slack/settings",
- "description" : "Update Metabot Slack settings atomically.\n All credential fields must be provided together.\n Setting values requires the metabot-v3 feature, but clearing values is always allowed.\n slack-connect-enabled is automatically set to true when credentials are provided, nil when cleared.",
- "parameters" : [ ],
+ "operationId" : "put-api-ee-tenant-id",
+ "summary" : "PUT /api/ee/tenant/{id}",
+ "description" : "Update a tenant, can set name, attributes, or whether this tenant is active.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response",
@@ -31457,11 +31118,45 @@
"schema" : {
"type" : "object",
"properties" : {
- "ok" : {
+ "attributes" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_active" : {
"type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "type" : "string",
+ "pattern" : "^[-_a-z0-9]{1,255}$"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}
},
- "required" : [ "ok" ]
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
+ "additionalProperties" : false
}
}
}
@@ -31479,23 +31174,22 @@
"schema" : {
"type" : "object",
"properties" : {
- "metabot-slack-signing-secret" : {
+ "attributes" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "object",
+ "additionalProperties" : { }
}, {
"type" : "null"
} ]
},
- "slack-connect-client-id" : {
+ "is_active" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "slack-connect-client-secret" : {
+ "name" : {
"oneOf" : [ {
"type" : "string",
"minLength" : 1
@@ -31504,42 +31198,26 @@
} ]
}
},
- "required" : [ "slack-connect-client-id", "slack-connect-client-secret", "metabot-slack-signing-secret" ]
+ "additionalProperties" : false
}
}
}
},
- "tags" : [ "/api/ee/metabot-v3/slack" ]
- }
- },
- "/api/ee/permission_debug" : {
+ "tags" : [ "/api/ee/tenant" ]
+ },
"get" : {
- "operationId" : "get-api-ee-permission_debug",
- "summary" : "GET /api/ee/permission_debug",
- "description" : "This endpoint expects a `user_id`, a `model_id` to debug permissions against, and `action_type`.\n The type of model we are debugging against is inferred by the `action_type`.\n\n It will return:\n - `decision`: The overall permission decision (\"allow\", \"denied\", or \"limited\")\n - `model-type`: The type of model being checked (e.g., \"question\")\n - `model-id`: The ID of the model being checked\n - `segment`: A set of segmentation types applied (e.g., \"sandboxed\", \"impersonated\", \"routed\")\n - `message`: A sequence of strings explaining the decision\n - `data`: A map containing details about permissions (table or collection names to group names)\n - `suggestions`: A map of group IDs to group names that could provide access\n\n Example requests:\n - Check if user can read a card: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/read`\n - Check if user can query a card: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/query`\n - Check if user can download data: `GET /api/ee/permission_debug?user_id=123&model_id=456&action_type=card/download-data`\n\n Example responses:\n - Allowed access:\n ```json\n {\n \"decision\": \"allow\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User has permission to read this card\"],\n \"data\": {},\n \"suggestions\": {}\n }\n ```\n - Denied access with blocked table:\n ```json\n {\n \"decision\": \"denied\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User does not have permission to query this card\"],\n \"data\": {\"sample-db.PUBLIC.ORDERS\": [\"All Users\"]},\n \"suggestions\": {}\n }\n ```\n - Limited access:\n ```json\n {\n \"decision\": \"limited\",\n \"model-type\": \"question\",\n \"model-id\": \"456\",\n \"segment\": [],\n \"message\": [\"User has permission to download some data from this card\"],\n \"data\": {},\n \"suggestions\": {}\n }\n ```",
+ "operationId" : "get-api-ee-tenant-id",
+ "summary" : "GET /api/ee/tenant/{id}",
+ "description" : "Get info about a tenant",
"parameters" : [ {
- "in" : "query",
- "name" : "user_id",
+ "in" : "path",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
- }
- }, {
- "in" : "query",
- "name" : "model_id",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "action_type",
- "required" : true,
- "schema" : {
- "type" : "string",
- "enum" : [ "card/read", "card/query", "card/download-data" ]
- }
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
@@ -31547,7 +31225,47 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.permission-debug.impl.perm-debug-info"
+ "type" : "object",
+ "properties" : {
+ "attributes" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "type" : "string",
+ "pattern" : "^[-_a-z0-9]{1,255}$"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
+ "additionalProperties" : false
}
}
}
@@ -31559,34 +31277,26 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/permission_debug" ]
+ "tags" : [ "/api/ee/tenant" ]
}
},
- "/api/ee/remote-sync/branches" : {
+ "/api/ee/transforms-python/library/{path}" : {
"get" : {
- "operationId" : "get-api-ee-remote-sync-branches",
- "summary" : "GET /api/ee/remote-sync/branches",
- "description" : "Get list of branches from the configured source.\n\n Returns a JSON object with branch names under the :items key.\n\n Requires superuser permissions.",
- "parameters" : [ ],
+ "operationId" : "get-api-ee-transforms-python-library-path",
+ "summary" : "GET /api/ee/transforms-python/library/{path}",
+ "description" : "Get the Python library for user modules.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "items" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- },
- "required" : [ "items" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -31595,34 +31305,24 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/remote-sync" ]
- }
- },
- "/api/ee/remote-sync/create-branch" : {
- "post" : {
- "operationId" : "post-api-ee-remote-sync-create-branch",
- "summary" : "POST /api/ee/remote-sync/create-branch",
- "description" : "Create a new branch from the current remote-sync branch and switches the current remote-sync branch to it.\n Requires superuser permissions.",
- "parameters" : [ ],
+ "tags" : [ "/api/ee/transforms-python" ]
+ },
+ "put" : {
+ "operationId" : "put-api-ee-transforms-python-library-path",
+ "summary" : "PUT /api/ee/transforms-python/library/{path}",
+ "description" : "Update the Python library source code for user modules.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "message" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string"
- }
- },
- "required" : [ "status", "message" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -31637,129 +31337,24 @@
"schema" : {
"type" : "object",
"properties" : {
- "name" : {
- "type" : "string",
- "minLength" : 1
+ "source" : {
+ "type" : "string"
}
},
- "required" : [ "name" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/remote-sync" ]
- }
- },
- "/api/ee/remote-sync/current-task" : {
- "get" : {
- "operationId" : "get-api-ee-remote-sync-current-task",
- "summary" : "GET /api/ee/remote-sync/current-task",
- "description" : "Get the current sync task",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "progress" : {
- "oneOf" : [ {
- "type" : "number",
- "minimum" : 0.0,
- "maximum" : 1.0
- }, {
- "type" : "null"
- } ]
- },
- "conflicts" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }, {
- "type" : "null"
- } ]
- },
- "last_progress_report_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "started_at" : { },
- "ended_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "initiated_by" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "cancelled" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "status" : {
- "type" : "string",
- "enum" : [ "running", "successful", "errored", "cancelled", "timed-out", "conflict" ]
- },
- "error_message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "sync_task_type" : {
- "type" : "string",
- "enum" : [ "import", "export" ]
- },
- "version" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "sync_task_type", "progress", "started_at", "status" ]
- }, {
- "type" : "null"
- } ]
- }
+ "required" : [ "source" ],
+ "additionalProperties" : false
}
}
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
}
},
- "tags" : [ "/api/ee/remote-sync" ]
+ "tags" : [ "/api/ee/transforms-python" ]
}
},
- "/api/ee/remote-sync/current-task/cancel" : {
+ "/api/ee/transforms-python/test-run" : {
"post" : {
- "operationId" : "post-api-ee-remote-sync-current-task-cancel",
- "summary" : "POST /api/ee/remote-sync/current-task/cancel",
- "description" : "Cancels the current task if one is running",
+ "operationId" : "post-api-ee-transforms-python-test-run",
+ "summary" : "POST /api/ee/transforms-python/test-run",
+ "description" : "Evaluate an ad-hoc python transform on a sample of input data.\n Intended for short runs for early feedback. Input/output/timeout limits apply.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -31769,191 +31364,42 @@
"schema" : {
"type" : "object",
"properties" : {
- "progress" : {
- "oneOf" : [ {
- "type" : "number",
- "minimum" : 0.0,
- "maximum" : 1.0
- }, {
- "type" : "null"
- } ]
- },
- "conflicts" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "type" : "string"
+ "error" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "anyOf" : [ { }, { } ]
}
- }, {
- "type" : "null"
- } ]
- },
- "last_progress_report_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "started_at" : { },
- "ended_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "initiated_by" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "cancelled" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "status" : {
- "type" : "string",
- "enum" : [ "running", "successful", "errored", "cancelled", "timed-out", "conflict" ]
- },
- "error_message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ },
+ "required" : [ "message" ]
},
- "sync_task_type" : {
- "type" : "string",
- "enum" : [ "import", "export" ]
+ "logs" : {
+ "type" : "string"
},
- "version" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "sync_task_type", "progress", "started_at", "status" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/remote-sync" ]
- }
- },
- "/api/ee/remote-sync/dirty" : {
- "get" : {
- "operationId" : "get-api-ee-remote-sync-dirty",
- "summary" : "GET /api/ee/remote-sync/dirty",
- "description" : "Return all models with changes that have not been pushed to the remote sync source in any\n remote-synced collection.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "dirty" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "table_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "model" : {
- "type" : "string"
- },
- "authority_level" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer"
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "updated_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "table_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "query_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "created_at" : { },
- "display" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "sync_status" : {
- "type" : "string"
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "output" : {
+ "type" : "object",
+ "properties" : {
+ "cols" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name" ]
}
},
- "required" : [ "id", "name", "model", "sync_status" ]
- }
+ "rows" : {
+ "type" : "array",
+ "items" : { }
+ }
+ },
+ "required" : [ "cols", "rows" ]
}
},
- "required" : [ "dirty" ]
+ "required" : [ "logs" ]
}
}
}
@@ -31965,32 +31411,75 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/remote-sync" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "code" : {
+ "type" : "string"
+ },
+ "output_row_limit" : {
+ "allOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "number",
+ "exclusiveMinimum" : 1
+ }, {
+ "type" : "number",
+ "maximum" : 100
+ } ]
+ },
+ "per_input_row_limit" : {
+ "allOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "number",
+ "exclusiveMinimum" : 1
+ }, {
+ "type" : "number",
+ "maximum" : 100
+ } ]
+ },
+ "source_tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-base.util.source-table-entry"
+ },
+ "minItems" : 1
+ }
+ },
+ "required" : [ "code", "source_tables" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/transforms-python" ]
}
},
- "/api/ee/remote-sync/export" : {
- "post" : {
- "operationId" : "post-api-ee-remote-sync-export",
- "summary" : "POST /api/ee/remote-sync/export",
- "description" : "Export the current state of the Remote Sync collection to a Source.\n\n This endpoint will:\n - Fetch the latest changes from the source\n - Create a branch or subdirectory (depending on source support)\n If no branch is supplied, use the configured export branch\n - Export the Remote Sync collection via serialization to the branch or subdirectory\n - Commit the changes if possible\n - Sync to the source if possible\n\n Requires superuser permissions.",
- "parameters" : [ ],
+ "/api/ee/transforms/{id}/inspect" : {
+ "get" : {
+ "operationId" : "get-api-ee-transforms-id-inspect",
+ "summary" : "GET /api/ee/transforms/{id}/inspect",
+ "description" : "Phase 1: Discover available lenses for a transform.\n Returns structural metadata and available lens types.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "message" : {
- "type" : "string"
- },
- "task_id" : {
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "message", "task_id" ]
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.discovery-response"
}
}
}
@@ -32002,20 +31491,30 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/remote-sync" ]
+ "tags" : [ "/api/ee/transforms" ]
}
},
- "/api/ee/remote-sync/has-remote-changes" : {
+ "/api/ee/transforms/{id}/inspect/{lens-id}" : {
"get" : {
- "operationId" : "get-api-ee-remote-sync-has-remote-changes",
- "summary" : "GET /api/ee/remote-sync/has-remote-changes",
- "description" : "Check if there are new changes on the remote branch that can be pulled.\n Uses in-memory caching (configurable TTL via remote-sync-check-changes-cache-ttl-seconds setting).\n\n Returns:\n - has_changes: true if remote version differs from last imported version, or if never imported\n - remote_version: current Git SHA on remote branch\n - local_version: Git SHA of last successful import (nil if never imported)\n - cached: true if result was served from cache",
+ "operationId" : "get-api-ee-transforms-id-inspect-lens-id",
+ "summary" : "GET /api/ee/transforms/{id}/inspect/{lens-id}",
+ "description" : "Phase 2: Get full lens contents for a transform.\n Returns sections, cards with dataset_query, and trigger definitions.\n Accepts optional params for drill lenses as query params.",
"parameters" : [ {
- "in" : "query",
- "name" : "force-refresh",
- "required" : false,
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
"schema" : {
- "type" : "boolean"
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "lens-id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
}
} ],
"responses" : {
@@ -32024,30 +31523,7 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "cached" : {
- "type" : "boolean"
- },
- "has_changes" : {
- "type" : "boolean"
- },
- "local_version" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "remote_version" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "has_changes", "remote_version", "local_version", "cached" ]
+ "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens"
}
}
}
@@ -32059,43 +31535,39 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/remote-sync" ]
+ "tags" : [ "/api/ee/transforms" ]
}
},
- "/api/ee/remote-sync/import" : {
+ "/api/ee/transforms/{id}/inspect/{lens-id}/query" : {
"post" : {
- "operationId" : "post-api-ee-remote-sync-import",
- "summary" : "POST /api/ee/remote-sync/import",
- "description" : "Import Metabase content from configured Remote Sync source.\n\n This endpoint will:\n - Fetch the latest changes from the configured source\n - Load the updated content using the serialization/deserialization system\n\n If `force=false` (default) and there are unsaved changes in the Remote Sync collection,\n the import returns a 400 response.\n\n Requires superuser permissions.",
- "parameters" : [ ],
+ "operationId" : "post-api-ee-transforms-id-inspect-lens-id-query",
+ "summary" : "POST /api/ee/transforms/{id}/inspect/{lens-id}/query",
+ "description" : "Execute a query in the context of a transform inspector lens.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "lens-id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "type" : "object",
- "properties" : {
- "message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "status" : {
- "const" : "success"
- },
- "task_id" : {
- "oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "status", "task_id" ]
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
}
}
}
@@ -32113,43 +31585,44 @@
"schema" : {
"type" : "object",
"properties" : {
- "branch" : {
- "type" : "string",
- "minLength" : 1
+ "lens_params" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : { }
+ }, {
+ "type" : "null"
+ } ]
},
- "force" : {
- "type" : "boolean"
+ "query" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
}
- }
+ },
+ "required" : [ "query" ]
}
}
}
},
- "tags" : [ "/api/ee/remote-sync" ]
+ "tags" : [ "/api/ee/transforms" ]
}
},
- "/api/ee/remote-sync/is-dirty" : {
+ "/api/ee/upload-management/tables" : {
"get" : {
- "operationId" : "get-api-ee-remote-sync-is-dirty",
- "summary" : "GET /api/ee/remote-sync/is-dirty",
- "description" : "Check if any remote-synced collection or collection item has local changes that have not been pushed\n to the remote sync source.",
+ "operationId" : "get-api-ee-upload-management-tables",
+ "summary" : "GET /api/ee/upload-management/tables",
+ "description" : "Get all `Tables` visible to the current user which were created by uploading a file.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "is_dirty" : {
- "type" : "boolean"
- }
- },
- "required" : [ "is_dirty" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -32158,35 +31631,39 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/remote-sync" ]
+ "tags" : [ "/api/ee/upload-management" ]
}
},
- "/api/ee/remote-sync/settings" : {
- "put" : {
- "operationId" : "put-api-ee-remote-sync-settings",
- "summary" : "PUT /api/ee/remote-sync/settings",
- "description" : "Update Remote Sync related settings. You must be a superuser to do this.",
- "parameters" : [ ],
+ "/api/ee/upload-management/tables/{id}" : {
+ "delete" : {
+ "operationId" : "delete-api-ee-upload-management-tables-id",
+ "summary" : "DELETE /api/ee/upload-management/tables/{id}",
+ "description" : "Delete the uploaded table from the database, optionally archiving cards for which it is the primary source.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "archive-cards",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "success" : {
- "type" : "boolean"
- },
- "task_id" : {
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "success" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -32195,78 +31672,14 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "collections" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "boolean"
- }
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-auto-import" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-branch" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-token" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-transforms" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-type" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "read-only", "read-write" ]
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-url" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }
- }
- }
- }
- },
- "tags" : [ "/api/ee/remote-sync" ]
+ "tags" : [ "/api/ee/upload-management" ]
}
},
- "/api/ee/remote-sync/stash" : {
- "post" : {
- "operationId" : "post-api-ee-remote-sync-stash",
- "summary" : "POST /api/ee/remote-sync/stash",
- "description" : "Stashes changes to a new branch, and changes the current branch to it.\n Requires superuser permissions.",
+ "/api/ee/workspace" : {
+ "get" : {
+ "operationId" : "get-api-ee-workspace",
+ "summary" : "GET /api/ee/workspace",
+ "description" : "Get a list of all workspaces",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -32276,65 +31689,50 @@
"schema" : {
"type" : "object",
"properties" : {
- "message" : {
- "type" : "string"
+ "items" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
+ },
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ }
+ },
+ "required" : [ "id", "database_id", "name", "status", "updated_at" ],
+ "additionalProperties" : false
+ }
},
- "status" : {
- "type" : "string"
+ "limit" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "task_id" : {
- "type" : "integer",
- "minimum" : 1
+ "offset" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "status", "message", "task_id" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "message" : {
- "type" : "string",
- "minLength" : 1
- },
- "new_branch" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "new_branch", "message" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/remote-sync" ]
- }
- },
- "/api/ee/replacement/check-replace-source" : {
- "post" : {
- "operationId" : "post-api-ee-replacement-check-replace-source",
- "summary" : "POST /api/ee/replacement/check-replace-source",
- "description" : "Check whether a source entity can be replaced by a target entity. Returns compatibility\n errors describing column mismatches, type mismatches, primary key mismatches, and foreign\n key mismatches.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.check-replace-source-response"
+ "required" : [ "items", "limit", "offset" ],
+ "additionalProperties" : false
}
}
}
@@ -32346,62 +31744,47 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "source_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
- },
- "source_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
- },
- "target_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
- },
- "target_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
- }
- },
- "required" : [ "source_entity_id", "source_entity_type", "target_entity_id", "target_entity_type" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/replacement" ]
- }
- },
- "/api/ee/replacement/replace-source" : {
+ "tags" : [ "/api/ee/workspace" ]
+ },
"post" : {
- "operationId" : "post-api-ee-replacement-replace-source",
- "summary" : "POST /api/ee/replacement/replace-source",
- "description" : "Replace all usages of a source entity with a target entity asynchronously.\n Returns 202 with a run_id for polling. Returns 409 if a replacement is already running.",
+ "operationId" : "post-api-ee-workspace",
+ "summary" : "POST /api/ee/workspace",
+ "description" : "Create a new workspace\n\n Potential payload:\n {:name \"a\" :database_id 2}}",
"parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response",
"content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "body" : {
- "type" : "object",
- "properties" : {
- "run_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
- }
- },
- "required" : [ "run_id" ],
- "additionalProperties" : false
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
},
"status" : {
- "const" : 202
+ "type" : "string",
+ "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
+ },
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
}
},
- "required" : [ "status", "body" ]
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
}
}
}
@@ -32419,39 +31802,35 @@
"schema" : {
"type" : "object",
"properties" : {
- "source_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
- },
- "source_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
- },
- "target_entity_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
},
- "target_entity_type" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
}
- },
- "required" : [ "source_entity_id", "source_entity_type", "target_entity_id", "target_entity_type" ]
+ }
}
}
}
},
- "tags" : [ "/api/ee/replacement" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/replacement/runs/{id}" : {
+ "/api/ee/workspace/checkout" : {
"get" : {
- "operationId" : "get-api-ee-replacement-runs-id",
- "summary" : "GET /api/ee/replacement/runs/{id}",
- "description" : "Get the status of a source replacement run.",
+ "operationId" : "get-api-ee-workspace-checkout",
+ "summary" : "GET /api/ee/workspace/checkout",
+ "description" : "Get checkout status for a global transform.\n\n Returns:\n - checkout_disabled: Why this transform cannot be checked out (nil if allowed)\n - workspaces: All workspaces for this transform's database, with checkout status\n - transforms: (DEPRECATED) Use :workspaces instead",
"parameters" : [ {
- "in" : "path",
- "name" : "id",
+ "in" : "query",
+ "name" : "transform-id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
@@ -32459,7 +31838,82 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run"
+ "type" : "object",
+ "properties" : {
+ "checkout_disabled" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "mbql", "card-reference", "unknown-type" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transforms" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "workspace" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ]
+ }
+ },
+ "required" : [ "id", "name", "workspace" ]
+ }
+ },
+ "workspaces" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "existing" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ },
+ "required" : [ "ref_id", "name" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
+ }
+ },
+ "required" : [ "id", "name", "status", "existing" ]
+ }
+ }
+ },
+ "required" : [ "checkout_disabled", "workspaces", "transforms" ]
}
}
}
@@ -32471,22 +31925,15 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/replacement" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/replacement/runs/{id}/cancel" : {
- "post" : {
- "operationId" : "post-api-ee-replacement-runs-id-cancel",
- "summary" : "POST /api/ee/replacement/runs/{id}/cancel",
- "description" : "Cancel a running source replacement.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
- }
- } ],
+ "/api/ee/workspace/database" : {
+ "get" : {
+ "operationId" : "get-api-ee-workspace-database",
+ "summary" : "GET /api/ee/workspace/database",
+ "description" : "Get a list supported databases, and whether they're enabled and have required permissions.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response",
@@ -32495,11 +31942,43 @@
"schema" : {
"type" : "object",
"properties" : {
- "success" : {
- "type" : "boolean"
+ "databases" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "enabled" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "permissions_status" : {
+ "type" : "object",
+ "properties" : {
+ "checked_at" : {
+ "type" : "string"
+ },
+ "error" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "status", "checked_at" ]
+ }
+ },
+ "required" : [ "id", "name", "enabled" ]
+ }
}
},
- "required" : [ "success" ]
+ "required" : [ "databases" ]
}
}
}
@@ -32511,112 +31990,43 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/replacement" ]
- }
- },
- "/api/ee/scim/api_key" : {
- "get" : {
- "operationId" : "get-api-ee-scim-api_key",
- "summary" : "GET /api/ee/scim/api_key",
- "description" : "Fetch the SCIM API key if one exists. Does *not* return an unmasked key, since we don't have access\n to that after it is created.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/scim" ]
- },
- "post" : {
- "operationId" : "post-api-ee-scim-api_key",
- "summary" : "POST /api/ee/scim/api_key",
- "description" : "Create a new SCIM API key, or refresh one that already exists. When called for the first time,\n this is equivalent to enabling SCIM.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/scim" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/scim/v2/Groups" : {
+ "/api/ee/workspace/enabled" : {
"get" : {
- "operationId" : "get-api-ee-scim-v2-Groups",
- "summary" : "GET /api/ee/scim/v2/Groups",
- "description" : "Fetch a list of groups.",
+ "operationId" : "get-api-ee-workspace-enabled",
+ "summary" : "GET /api/ee/workspace/enabled",
+ "description" : "Test whether the current user can use Workspaces. Optionally takes a specific database.\n Factors include: driver support, database user privileges, metabase permissions.",
"parameters" : [ {
"in" : "query",
- "name" : "startIndex",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "count",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "filter",
+ "name" : "database-id",
"required" : false,
"schema" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
+ "type" : "integer",
+ "minimum" : 1
},
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/scim/v2" ]
- },
- "post" : {
- "operationId" : "post-api-ee-scim-v2-Groups",
- "summary" : "POST /api/ee/scim/v2/Groups",
- "description" : "Create a single group, and populates it if necessary.",
- "parameters" : [ ],
+ "description" : "value must be an integer greater than zero."
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "reason" : {
+ "type" : "string"
+ },
+ "supported" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "supported" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -32625,70 +32035,61 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "displayName" : {
- "type" : "string",
- "minLength" : 1
- },
- "id" : {
- "type" : "string",
- "minLength" : 1
- },
- "members" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "$ref" : {
- "type" : "string",
- "minLength" : 1
- },
- "value" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "value" ]
- }
- },
- "schemas" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
- }
- }
- },
- "required" : [ "schemas", "displayName" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/scim/v2" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/scim/v2/Groups/{id}" : {
+ "/api/ee/workspace/{ws-id}" : {
"get" : {
- "operationId" : "get-api-ee-scim-v2-Groups-id",
- "summary" : "GET /api/ee/scim/v2/Groups/{id}",
- "description" : "Fetch a single group.",
+ "operationId" : "get-api-ee-workspace-ws-id",
+ "summary" : "GET /api/ee/workspace/{ws-id}",
+ "description" : "Get a single workspace by ID",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
+ },
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ }
+ },
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -32697,16 +32098,59 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/scim/v2" ]
+ "tags" : [ "/api/ee/workspace" ]
},
"put" : {
- "operationId" : "put-api-ee-scim-v2-Groups-id",
- "summary" : "PUT /api/ee/scim/v2/Groups/{id}",
- "description" : "Update a group.",
- "parameters" : [ ],
+ "operationId" : "put-api-ee-workspace-ws-id",
+ "summary" : "PUT /api/ee/workspace/{ws-id}",
+ "description" : "Update simple workspace properties.\n\n Can set database_id only on uninitialized workspaces.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
+ },
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ }
+ },
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -32721,62 +32165,51 @@
"schema" : {
"type" : "object",
"properties" : {
- "displayName" : {
- "type" : "string",
- "minLength" : 1
- },
- "id" : {
- "type" : "string",
- "minLength" : 1
- },
- "members" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "$ref" : {
- "type" : "string",
- "minLength" : 1
- },
- "value" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "value" ]
- }
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
},
- "schemas" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
- }
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
}
},
- "required" : [ "schemas", "displayName" ]
+ "additionalProperties" : false
}
}
}
},
- "tags" : [ "/api/ee/scim/v2" ]
+ "tags" : [ "/api/ee/workspace" ]
},
"delete" : {
- "operationId" : "delete-api-ee-scim-v2-Groups-id",
- "summary" : "DELETE /api/ee/scim/v2/Groups/{id}",
- "description" : "Delete a group.",
+ "operationId" : "delete-api-ee-workspace-ws-id",
+ "summary" : "DELETE /api/ee/workspace/{ws-id}",
+ "description" : "Delete a workspace and all its contents, including mirrored entities.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "ok" : {
+ "const" : true
+ }
+ },
+ "required" : [ "ok" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -32785,193 +32218,130 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/scim/v2" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/scim/v2/Users" : {
- "get" : {
- "operationId" : "get-api-ee-scim-v2-Users",
- "summary" : "GET /api/ee/scim/v2/Users",
- "description" : "Fetch a list of users.",
+ "/api/ee/workspace/{ws-id}/archive" : {
+ "post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-archive",
+ "summary" : "POST /api/ee/workspace/{ws-id}/archive",
+ "description" : "Archive a workspace. Deletes the isolated schema and tables, but preserves mirrored entities.",
"parameters" : [ {
- "in" : "query",
- "name" : "startIndex",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "count",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "filter",
- "required" : false,
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
+ "type" : "integer",
+ "minimum" : 1
},
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/ee/scim/v2" ]
- },
- "post" : {
- "operationId" : "post-api-ee-scim-v2-Users",
- "summary" : "POST /api/ee/scim/v2/Users",
- "description" : "Create a single user.",
- "parameters" : [ ],
+ "description" : "value must be an integer greater than zero."
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "type" : "boolean"
- },
- "emails" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "primary" : {
- "type" : "boolean"
- },
- "type" : {
- "type" : "string",
- "minLength" : 1
- },
- "value" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "value" ]
- }
- },
- "groups" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "$ref" : {
- "type" : "string",
- "minLength" : 1
- },
- "display" : {
- "type" : "string",
- "minLength" : 1
- },
- "value" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "value", "display" ]
- }
- },
- "id" : {
- "type" : "string",
- "minLength" : 1
- },
- "locale" : {
- "oneOf" : [ {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
"type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "object",
- "properties" : {
- "familyName" : {
- "type" : "string"
- },
- "givenName" : {
- "type" : "string"
- }
+ "format" : "date-time"
},
- "required" : [ "givenName", "familyName" ]
- },
- "schemas" : {
- "type" : "array",
- "items" : {
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
"type" : "string",
- "minLength" : 1
+ "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
+ },
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
}
},
- "userName" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "schemas", "userName", "name", "emails" ]
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
+ }
}
}
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "tags" : [ "/api/ee/scim/v2" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/scim/v2/Users/{id}" : {
+ "/api/ee/workspace/{ws-id}/external/transform" : {
"get" : {
- "operationId" : "get-api-ee-scim-v2-Users-id",
- "summary" : "GET /api/ee/scim/v2/Users/{id}",
- "description" : "Fetch a single user.",
+ "operationId" : "get-api-ee-workspace-ws-id-external-transform",
+ "summary" : "GET /api/ee/workspace/{ws-id}/external/transform",
+ "description" : "Get transforms that are external to the workspace, i.e. no matching workspace_transform row exists.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ }, {
+ "in" : "query",
+ "name" : "database-id",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "transforms" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "checkout_disabled" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "source_type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "source_type", "checkout_disabled" ]
+ }
+ }
+ },
+ "required" : [ "transforms" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -32980,16 +32350,98 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/scim/v2" ]
- },
- "put" : {
- "operationId" : "put-api-ee-scim-v2-Users-id",
- "summary" : "PUT /api/ee/scim/v2/Users/{id}",
- "description" : "Update a user.",
- "parameters" : [ ],
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/graph" : {
+ "get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-graph",
+ "summary" : "GET /api/ee/workspace/{ws-id}/graph",
+ "description" : "Display the dependency graph between the Changeset and the (potentially external) entities that they depend on.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "edges" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "from_entity_id" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ } ]
+ },
+ "from_entity_type" : {
+ "type" : "string"
+ },
+ "to_entity_id" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ } ]
+ },
+ "to_entity_type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "from_entity_id", "from_entity_type", "to_entity_id", "to_entity_type" ]
+ }
+ },
+ "nodes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "dependents_count" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "id" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ } ]
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "input-table", "external-transform", "workspace-transform" ]
+ }
+ },
+ "required" : [ "id", "type", "dependents_count", "data" ]
+ }
+ }
+ },
+ "required" : [ "nodes", "edges" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -32998,115 +32450,83 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "type" : "boolean"
- },
- "emails" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "primary" : {
- "type" : "boolean"
- },
- "type" : {
- "type" : "string",
- "minLength" : 1
- },
- "value" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "value" ]
- }
- },
- "groups" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "$ref" : {
- "type" : "string",
- "minLength" : 1
- },
- "display" : {
- "type" : "string",
- "minLength" : 1
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/input/grant" : {
+ "post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-input-grant",
+ "summary" : "POST /api/ee/workspace/{ws-id}/input/grant",
+ "description" : "Grant read access to input tables by table coordinates. Superuser only.\n Idempotent - returns which tables were already granted vs newly granted.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "already_granted" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
},
- "value" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "value", "display" ]
- }
- },
- "id" : {
- "type" : "string",
- "minLength" : 1
- },
- "locale" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "object",
- "properties" : {
- "familyName" : {
- "type" : "string"
- },
- "givenName" : {
- "type" : "string"
+ "required" : [ "db_id", "schema", "table" ]
+ }
+ },
+ "newly_granted" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "db_id", "schema", "table" ]
}
- },
- "required" : [ "givenName", "familyName" ]
- },
- "schemas" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
}
},
- "userName" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "schemas", "userName", "name", "emails" ]
+ "required" : [ "already_granted", "newly_granted" ]
+ }
}
}
- }
- },
- "tags" : [ "/api/ee/scim/v2" ]
- },
- "patch" : {
- "operationId" : "patch-api-ee-scim-v2-Users-id",
- "summary" : "PATCH /api/ee/scim/v2/Users/{id}",
- "description" : "Activate or deactivate a user. Supports specific replace operations, but not arbitrary patches.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -33121,62 +32541,87 @@
"schema" : {
"type" : "object",
"properties" : {
- "Operations" : {
+ "tables" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
- "op" : {
- "type" : "string",
- "minLength" : 1
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
},
- "value" : {
- "anyOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "anyOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "boolean"
- } ]
- }
- }, {
- "type" : "string",
- "minLength" : 1
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
- "type" : "boolean"
+ "type" : "null"
} ]
+ },
+ "table" : {
+ "type" : "string"
}
},
- "required" : [ "op", "value" ]
- }
- },
- "schemas" : {
- "type" : "array",
- "items" : {
- "type" : "string",
- "minLength" : 1
+ "required" : [ "db_id", "schema", "table" ]
}
}
},
- "required" : [ "schemas", "Operations" ]
+ "required" : [ "tables" ]
}
}
}
},
- "tags" : [ "/api/ee/scim/v2" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/semantic-search/status" : {
+ "/api/ee/workspace/{ws-id}/input/pending" : {
"get" : {
- "operationId" : "get-api-ee-semantic-search-status",
- "summary" : "GET /api/ee/semantic-search/status",
- "description" : "Fetch the indexing status of the currently active semantic search index table.\n\n Returns a map with keys:\n :indexed_count <number of indexed items>\n :total_est <estimated total number of items to index>\n\n If no index is active, returns an empty map.",
- "parameters" : [ ],
+ "operationId" : "get-api-ee-workspace-ws-id-input-pending",
+ "summary" : "GET /api/ee/workspace/{ws-id}/input/pending",
+ "description" : "List all input tables that haven't been granted access yet, excluding tables shadowed by workspace outputs.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "inputs" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "db_id", "schema", "table" ]
+ }
+ }
+ },
+ "required" : [ "inputs" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -33185,111 +32630,91 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/semantic-search" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/serialization/export" : {
- "post" : {
- "operationId" : "post-api-ee-serialization-export",
- "summary" : "POST /api/ee/serialization/export",
- "description" : "Serialize and retrieve Metabase instance.\n\n Outputs `.tar.gz` file with serialization results and an `export.log` file.\n On error outputs serialization logs directly.",
+ "/api/ee/workspace/{ws-id}/log" : {
+ "get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-log",
+ "summary" : "GET /api/ee/workspace/{ws-id}/log",
+ "description" : "Get workspace creation status and recent log entries for polling during async setup",
"parameters" : [ {
- "in" : "query",
- "name" : "dirname",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "description" : "name of directory and archive file (default: `<instance-name>-<YYYY-MM-dd_HH-mm>`)"
- }, {
- "in" : "query",
- "name" : "collection",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "string",
- "pattern" : "^.{21}$"
- }, {
- "type" : "string",
- "pattern" : "^eid:.{21}$"
- } ]
- }
- }, {
- "type" : "null"
- } ]
- },
- "description" : "collections' db ids/entity-ids to serialize"
- }, {
- "in" : "query",
- "name" : "all_collections",
- "required" : true,
- "schema" : {
- "default" : true,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "settings",
- "required" : true,
- "schema" : {
- "default" : true,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "data_model",
- "required" : true,
- "schema" : {
- "default" : true,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "field_values",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "database_secrets",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "continue_on_error",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "full_stacktrace",
+ "in" : "path",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "last_completed_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "logs" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "completed_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : { },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "started_at" : { },
+ "status" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "task" : {
+ "type" : "string"
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "task", "description", "started_at", "updated_at", "completed_at", "status", "message" ]
+ }
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
+ },
+ "updated_at" : { },
+ "workspace_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "workspace_id", "status", "updated_at", "last_completed_at", "logs" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -33298,42 +32723,103 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/serialization" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/serialization/import" : {
+ "/api/ee/workspace/{ws-id}/merge" : {
"post" : {
- "operationId" : "post-api-ee-serialization-import",
- "summary" : "POST /api/ee/serialization/import",
- "description" : "Deserialize Metabase instance from an archive generated by /export.\n\n Parameters:\n - `file`: archive encoded as `multipart/form-data` (required).\n\n Returns logs of deserialization.",
+ "operationId" : "post-api-ee-workspace-ws-id-merge",
+ "summary" : "POST /api/ee/workspace/{ws-id}/merge",
+ "description" : "This will:\n 1. Update original transforms with workspace versions\n 2. Archive the workspace and clean up isolated resources\n Returns a report of merged entities, or error in errors key.\n\n Request body may include:\n - commit-message: A description of what changes are being merged (optional, will be required in future)",
"parameters" : [ {
- "in" : "query",
- "name" : "continue_on_error",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "full_stacktrace",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "reindex",
+ "in" : "path",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "default" : true,
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "anyOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "errors" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "op" : {
+ "type" : "string",
+ "enum" : [ "create", "delete", "update", "noop" ]
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ },
+ "required" : [ "op", "ref_id" ]
+ }
+ },
+ "merged" : {
+ "type" : "object",
+ "properties" : {
+ "transforms" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "op" : {
+ "type" : "string",
+ "enum" : [ "create", "delete", "update", "noop" ]
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ },
+ "required" : [ "op", "ref_id" ]
+ }
+ }
+ },
+ "required" : [ "transforms" ]
+ },
+ "workspace" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ]
+ }
+ },
+ "required" : [ "merged", "errors", "workspace" ]
+ }, {
+ "type" : "string"
+ } ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -33344,96 +32830,50 @@
},
"requestBody" : {
"content" : {
- "multipart/form-data" : {
+ "application/json" : {
"schema" : {
"type" : "object",
"properties" : {
- "file" : {
- "description" : ".tgz with serialization data",
- "type" : "object",
- "properties" : {
- "content-type" : {
- "type" : "string"
- },
- "filename" : {
- "type" : "string"
- },
- "size" : {
- "type" : "integer"
- },
- "tempfile" : { }
- },
- "required" : [ "content-type", "filename", "size", "tempfile" ],
- "additionalProperties" : false
+ "commit-message" : {
+ "type" : "string",
+ "minLength" : 1
}
- },
- "required" : [ "file" ]
+ }
}
}
}
},
- "tags" : [ "/api/ee/serialization" ]
+ "tags" : [ "/api/ee/workspace" ]
}
- },
- "/api/ee/stale/{id}" : {
- "get" : {
- "operationId" : "get-api-ee-stale-id",
- "summary" : "GET /api/ee/stale/{id}",
- "description" : "A flexible endpoint that returns stale entities, in the same shape as collections/items, with the following options:\n - `before_date` - only return entities that were last edited before this date (default: 6 months ago)\n - `is_recursive` - if true, return entities from all children of the collection, not just the direct children (default: false)\n - `sort_column` - the column to sort by (default: name)\n - `sort_direction` - the direction to sort by (default: asc)",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "const" : "root"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "before_date",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "is_recursive",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "sort_column",
- "required" : true,
- "schema" : {
- "default" : "name",
- "type" : "string",
- "enum" : [ "name", "last_used_at" ]
- }
- }, {
- "in" : "query",
- "name" : "sort_direction",
+ },
+ "/api/ee/workspace/{ws-id}/problem" : {
+ "get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-problem",
+ "summary" : "GET /api/ee/workspace/{ws-id}/problem",
+ "description" : "Detect problems in the workspace that would affect downstream transforms after merge.\n\n Returns a list of problems, each with:\n - category: the problem category (e.g. 'unused', 'internal-downstream', 'external-downstream')\n - problem: the specific problem (e.g. 'not-run', 'stale', 'removed-field')\n - severity: :error, :warning, or :info\n - block-merge: whether this problem prevents merging\n - data: extra information, shape depends on the problem type\n\n See `metabase-enterprise.workspaces.types/problem-types` for the full list.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "default" : "asc",
- "type" : "string",
- "enum" : [ "asc", "desc" ]
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.problem"
+ }
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -33442,22 +32882,29 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/stale" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/support-access-grant" : {
+ "/api/ee/workspace/{ws-id}/query" : {
"post" : {
- "operationId" : "post-api-ee-support-access-grant",
- "summary" : "POST /api/ee/support-access-grant",
- "description" : "Create a new support access grant.\n\n Requires superuser permissions. Only one active grant can exist at a time.",
- "parameters" : [ ],
+ "operationId" : "post-api-ee-workspace-ws-id-query",
+ "summary" : "POST /api/ee/workspace/{ws-id}/query",
+ "description" : "Execute an arbitrary SQL query in the workspace's isolated database context.\n Table references are remapped to isolated workspace tables.\n Returns the first 2000 rows of query results.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.query-result"
}
}
}
@@ -33473,51 +32920,32 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.create-grant-request"
+ "type" : "object",
+ "properties" : {
+ "sql" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "sql" ]
}
}
}
},
- "tags" : [ "/api/ee/support-access-grant" ]
- },
- "get" : {
- "operationId" : "get-api-ee-support-access-grant",
- "summary" : "GET /api/ee/support-access-grant",
- "description" : "List support access grants with optional filtering and pagination.\n\n Requires superuser permissions.\n\n Query parameters:\n - ticket-number: Filter by ticket number\n - user-id: Filter by user who created the grant\n - include-revoked: Include revoked grants (default false)",
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/run" : {
+ "post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-run",
+ "summary" : "POST /api/ee/workspace/{ws-id}/run",
+ "description" : "Execute all transforms in the workspace in dependency order.\n Returns which transforms succeeded, failed, and were not run.",
"parameters" : [ {
- "in" : "query",
- "name" : "ticket-number",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "user-id",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include-revoked",
- "required" : false,
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
} ],
"responses" : {
@@ -33526,7 +32954,28 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.list-grants-response"
+ "type" : "object",
+ "properties" : {
+ "failed" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ },
+ "not_run" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ },
+ "succeeded" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ }
+ },
+ "required" : [ "succeeded", "failed", "not_run" ]
}
}
}
@@ -33538,22 +32987,146 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/support-access-grant" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "stale_only" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.flag"
+ }
+ }
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/support-access-grant/current" : {
+ "/api/ee/workspace/{ws-id}/table" : {
"get" : {
- "operationId" : "get-api-ee-support-access-grant-current",
- "summary" : "GET /api/ee/support-access-grant/current",
- "description" : "Get the currently active support access grant, if one exists.\n\n Requires superuser permissions.",
- "parameters" : [ ],
+ "operationId" : "get-api-ee-workspace-ws-id-table",
+ "summary" : "GET /api/ee/workspace/{ws-id}/table",
+ "description" : "Get workspace tables",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.current-grant-response"
+ "type" : "object",
+ "properties" : {
+ "inputs" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "db_id", "schema", "table", "table_id" ]
+ }
+ },
+ "outputs" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "global" : {
+ "type" : "object",
+ "properties" : {
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "transform_id", "schema", "table", "table_id" ]
+ },
+ "isolated" : {
+ "type" : "object",
+ "properties" : {
+ "schema" : {
+ "type" : "string"
+ },
+ "table" : {
+ "type" : "string"
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ } ]
+ }
+ },
+ "required" : [ "transform_id", "schema", "table", "table_id" ]
+ }
+ },
+ "required" : [ "db_id", "global", "isolated" ]
+ }
+ }
+ },
+ "required" : [ "inputs", "outputs" ],
+ "additionalProperties" : false
}
}
}
@@ -33565,23 +33138,209 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/support-access-grant" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/support-access-grant/{id}/revoke" : {
- "put" : {
- "operationId" : "put-api-ee-support-access-grant-id-revoke",
- "summary" : "PUT /api/ee/support-access-grant/{id}/revoke",
- "description" : "Revoke an existing support access grant.\n\n Requires superuser permissions. Any admin can revoke any grant.",
+ "/api/ee/workspace/{ws-id}/transform" : {
+ "post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform",
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform",
+ "description" : "Add another transform to the Changeset. This could be a fork of an existing global transform, or something new.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "last_run_at" : { },
+ "target_stale" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "last_run_status" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "workspace_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "updated_at" : { },
+ "archived_at" : { },
+ "source" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "last_run_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "created_at" : { },
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "ref_id", "global_id", "name", "description", "source", "target", "target_stale", "workspace_id", "creator_id", "archived_at", "created_at", "updated_at", "last_run_at", "last_run_status", "last_run_message" ]
+ }
+ }
+ }
},
- "description" : "value must be an integer greater than zero."
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "source" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ },
+ "type" : {
+ "const" : "query"
+ }
+ },
+ "required" : [ "type", "query" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "string"
+ },
+ "source-database" : {
+ "type" : "integer"
+ },
+ "source-tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-base.util.source-table-entry"
+ }
+ },
+ "type" : {
+ "const" : "python"
+ }
+ },
+ "required" : [ "source-tables", "type", "body" ],
+ "additionalProperties" : false
+ } ]
+ },
+ "target" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "table" ]
+ }
+ },
+ "required" : [ "type", "name" ],
+ "additionalProperties" : false
+ }
+ },
+ "required" : [ "name", "source", "target" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/workspace" ]
+ },
+ "get" : {
+ "operationId" : "get-api-ee-workspace-ws-id-transform",
+ "summary" : "GET /api/ee/workspace/{ws-id}/transform",
+ "description" : "Get all transforms in a workspace.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
} ],
"responses" : {
"2XX" : {
@@ -33589,7 +33348,47 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
+ "type" : "object",
+ "properties" : {
+ "transforms" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "source_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "ref_id", "global_id", "name", "source_type", "creator_id" ],
+ "additionalProperties" : false
+ }
+ }
+ },
+ "required" : [ "transforms" ]
}
}
}
@@ -33601,15 +33400,29 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/support-access-grant" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/tenant" : {
+ "/api/ee/workspace/{ws-id}/transform/validate/target" : {
"post" : {
- "operationId" : "post-api-ee-tenant",
- "summary" : "POST /api/ee/tenant",
- "description" : "Create a new Tenant",
- "parameters" : [ ],
+ "operationId" : "post-api-ee-workspace-ws-id-transform-validate-target",
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/validate/target",
+ "description" : "Validate the target table for a workspace transform",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ }, {
+ "in" : "query",
+ "name" : "transform-id",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response",
@@ -33618,45 +33431,18 @@
"schema" : {
"type" : "object",
"properties" : {
- "attributes" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
+ "body" : {
+ "anyOf" : [ {
+ "type" : "string"
}, {
- "type" : "null"
+ "anyOf" : [ { }, { } ]
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_active" : {
- "type" : "boolean"
- },
- "member_count" : {
- "description" : "value must be an integer.",
+ "status" : {
"type" : "integer"
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "slug" : {
- "description" : "invalid slug",
- "type" : "string",
- "pattern" : "^[-_a-z0-9]{1,255}$"
- },
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
}
},
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "additionalProperties" : false
+ "required" : [ "status", "body" ]
}
}
}
@@ -33674,44 +33460,58 @@
"schema" : {
"type" : "object",
"properties" : {
- "attributes" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
},
- "slug" : {
- "description" : "invalid slug",
- "type" : "string",
- "pattern" : "^[-_a-z0-9]{1,255}$"
+ "target" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "schema", "name" ]
}
},
- "required" : [ "name", "slug" ],
- "additionalProperties" : false
+ "required" : [ "target" ]
}
}
}
},
- "tags" : [ "/api/ee/tenant" ]
- },
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}" : {
"get" : {
- "operationId" : "get-api-ee-tenant",
- "summary" : "GET /api/ee/tenant",
- "description" : "Get all tenants",
+ "operationId" : "get-api-ee-workspace-ws-id-transform-tx-id",
+ "summary" : "GET /api/ee/workspace/{ws-id}/transform/{tx-id}",
+ "description" : "Get a specific transform in a workspace.",
"parameters" : [ {
- "in" : "query",
- "name" : "status",
+ "in" : "path",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "default" : "all",
- "type" : "string",
- "enum" : [ "all", "deactivated", "active" ]
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ }, {
+ "in" : "path",
+ "name" : "tx-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
}
} ],
"responses" : {
@@ -33722,55 +33522,71 @@
"schema" : {
"type" : "object",
"properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "attributes" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_active" : {
- "type" : "boolean"
- },
- "member_count" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "slug" : {
- "description" : "invalid slug",
- "type" : "string",
- "pattern" : "^[-_a-z0-9]{1,255}$"
- },
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "additionalProperties" : false
- }
+ "last_run_at" : { },
+ "target_stale" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "last_run_status" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "workspace_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "updated_at" : { },
+ "archived_at" : { },
+ "source" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "last_run_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "created_at" : { },
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "data" ],
- "additionalProperties" : false
+ "required" : [ "ref_id", "global_id", "name", "description", "source", "target", "target_stale", "workspace_id", "creator_id", "archived_at", "created_at", "updated_at", "last_run_at", "last_run_status", "last_run_message" ]
}
}
}
@@ -33782,23 +33598,26 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/tenant" ]
- }
- },
- "/api/ee/tenant/{id}" : {
+ "tags" : [ "/api/ee/workspace" ]
+ },
"put" : {
- "operationId" : "put-api-ee-tenant-id",
- "summary" : "PUT /api/ee/tenant/{id}",
- "description" : "Update a tenant, can set name, attributes, or whether this tenant is active.",
+ "operationId" : "put-api-ee-workspace-ws-id-transform-tx-id",
+ "summary" : "PUT /api/ee/workspace/{ws-id}/transform/{tx-id}",
+ "description" : "Update or create a transform in a workspace.\n If the transform exists, updates it. If it doesn't exist, creates a new transform with the provided ref_id.\n For creation, name, source, and target are required.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ }, {
+ "in" : "path",
+ "name" : "tx-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
} ],
"responses" : {
"2XX" : {
@@ -33808,45 +33627,71 @@
"schema" : {
"type" : "object",
"properties" : {
- "attributes" : {
+ "last_run_at" : { },
+ "target_stale" : {
"oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "name" : {
+ "type" : "string"
},
- "is_active" : {
- "type" : "boolean"
+ "last_run_status" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "member_count" : {
- "description" : "value must be an integer.",
- "type" : "integer"
+ "workspace_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
},
- "name" : {
- "type" : "string",
- "minLength" : 1
+ "updated_at" : { },
+ "archived_at" : { },
+ "source" : {
+ "type" : "object",
+ "properties" : { }
},
- "slug" : {
- "description" : "invalid slug",
- "type" : "string",
- "pattern" : "^[-_a-z0-9]{1,255}$"
+ "last_run_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "target" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "created_at" : { },
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "additionalProperties" : false
+ "required" : [ "ref_id", "global_id", "name", "description", "source", "target", "target_stale", "workspace_id", "creator_id", "archived_at", "created_at", "updated_at", "last_run_at", "last_run_status", "last_run_message" ]
}
}
}
@@ -33864,98 +33709,117 @@
"schema" : {
"type" : "object",
"properties" : {
- "attributes" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
- }, {
- "type" : "null"
- } ]
- },
- "is_active" : {
+ "description" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
"name" : {
+ "type" : "string"
+ },
+ "source" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "object",
+ "properties" : {
+ "query" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ },
+ "type" : {
+ "const" : "query"
+ }
+ },
+ "required" : [ "type", "query" ]
}, {
- "type" : "null"
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "string"
+ },
+ "source-database" : {
+ "type" : "integer"
+ },
+ "source-tables" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-base.util.source-table-entry"
+ }
+ },
+ "type" : {
+ "const" : "python"
+ }
+ },
+ "required" : [ "source-tables", "type", "body" ],
+ "additionalProperties" : false
} ]
+ },
+ "target" : {
+ "type" : "object",
+ "properties" : {
+ "database" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "table" ]
+ }
+ },
+ "required" : [ "type", "name" ],
+ "additionalProperties" : false
}
- },
- "additionalProperties" : false
+ }
}
}
}
},
- "tags" : [ "/api/ee/tenant" ]
+ "tags" : [ "/api/ee/workspace" ]
},
- "get" : {
- "operationId" : "get-api-ee-tenant-id",
- "summary" : "GET /api/ee/tenant/{id}",
- "description" : "Get info about a tenant",
+ "delete" : {
+ "operationId" : "delete-api-ee-workspace-ws-id-transform-tx-id",
+ "summary" : "DELETE /api/ee/workspace/{ws-id}/transform/{tx-id}",
+ "description" : "Discard a transform from the changeset.\n Equivalent to resetting a checked-out transform to its global definition, or deleting a provisional transform.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "attributes" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "is_active" : {
- "type" : "boolean"
- },
- "member_count" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "slug" : {
- "description" : "invalid slug",
- "type" : "string",
- "pattern" : "^[-_a-z0-9]{1,255}$"
- },
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "additionalProperties" : false
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ }, {
+ "in" : "path",
+ "name" : "tx-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
}
}
}
@@ -33967,26 +33831,39 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/tenant" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/transforms-python/library/{path}" : {
- "get" : {
- "operationId" : "get-api-ee-transforms-python-library-path",
- "summary" : "GET /api/ee/transforms-python/library/{path}",
- "description" : "Get the Python library for user modules.",
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/archive" : {
+ "post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-archive",
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/archive",
+ "description" : "Mark the given transform to be archived when the workspace is merged.\n For provisional transforms we will skip even creating it in the first place.",
"parameters" : [ {
"in" : "path",
- "name" : "path",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ }, {
+ "in" : "path",
+ "name" : "tx-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -33995,24 +33872,39 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/transforms-python" ]
- },
- "put" : {
- "operationId" : "put-api-ee-transforms-python-library-path",
- "summary" : "PUT /api/ee/transforms-python/library/{path}",
- "description" : "Update the Python library source code for user modules.",
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/dry-run" : {
+ "post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-dry-run",
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/dry-run",
+ "description" : "Dry-run a transform in a workspace without persisting to the target table.\n\n Returns the first 2000 rows of transform output for preview purposes.\n Does not update last_run_at or create any database tables.\n\n When run_stale_ancestors is true, any stale ancestor transforms will be executed first\n in dependency order (these ARE persisted). If any ancestor fails, execution stops and\n the dry-run will not proceed.",
"parameters" : [ {
"in" : "path",
- "name" : "path",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ }, {
+ "in" : "path",
+ "name" : "tx-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.query-result"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -34027,25 +33919,37 @@
"schema" : {
"type" : "object",
"properties" : {
- "source" : {
- "type" : "string"
+ "run_stale_ancestors" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.flag"
}
- },
- "required" : [ "source" ],
- "additionalProperties" : false
+ }
}
}
}
},
- "tags" : [ "/api/ee/transforms-python" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/transforms-python/test-run" : {
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/merge" : {
"post" : {
- "operationId" : "post-api-ee-transforms-python-test-run",
- "summary" : "POST /api/ee/transforms-python/test-run",
- "description" : "Evaluate an ad-hoc python transform on a sample of input data.\n Intended for short runs for early feedback. Input/output/timeout limits apply.",
- "parameters" : [ ],
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-merge",
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/merge",
+ "description" : "Merge single transform from workspace back to the core. If workspace transform is archived\n the corresponding core transform is deleted.\n\n Request body may include:\n - commit-message: A description of what changes are being merged (optional, will be required in future)",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ }, {
+ "in" : "path",
+ "name" : "tx-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response",
@@ -34054,42 +33958,25 @@
"schema" : {
"type" : "object",
"properties" : {
- "error" : {
- "type" : "object",
- "properties" : {
- "message" : {
- "anyOf" : [ { }, { } ]
- }
- },
- "required" : [ "message" ]
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
},
- "logs" : {
+ "message" : {
"type" : "string"
},
- "output" : {
- "type" : "object",
- "properties" : {
- "cols" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "name" ]
- }
- },
- "rows" : {
- "type" : "array",
- "items" : { }
- }
- },
- "required" : [ "cols", "rows" ]
+ "op" : {
+ "type" : "string",
+ "enum" : [ "create", "delete", "update", "noop" ]
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
}
},
- "required" : [ "logs" ]
+ "required" : [ "op", "global_id", "ref_id" ]
}
}
}
@@ -34107,61 +33994,37 @@
"schema" : {
"type" : "object",
"properties" : {
- "code" : {
- "type" : "string"
- },
- "output_row_limit" : {
- "allOf" : [ {
- "type" : "integer"
- }, {
- "type" : "number",
- "exclusiveMinimum" : 1
- }, {
- "type" : "number",
- "maximum" : 100
- } ]
- },
- "per_input_row_limit" : {
- "allOf" : [ {
- "type" : "integer"
- }, {
- "type" : "number",
- "exclusiveMinimum" : 1
- }, {
- "type" : "number",
- "maximum" : 100
- } ]
- },
- "source_tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-base.util.source-table-entry"
- },
- "minItems" : 1
+ "commit-message" : {
+ "type" : "string",
+ "minLength" : 1
}
- },
- "required" : [ "code", "source_tables" ]
+ }
}
}
}
},
- "tags" : [ "/api/ee/transforms-python" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/transforms/{id}/inspect" : {
- "get" : {
- "operationId" : "get-api-ee-transforms-id-inspect",
- "summary" : "GET /api/ee/transforms/{id}/inspect",
- "description" : "Phase 1: Discover available lenses for a transform.\n Returns structural metadata and available lens types.",
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/run" : {
+ "post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-run",
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/run",
+ "description" : "Run a transform in a workspace.\n\n App DB changes are rolled back. Warehouse DB changes persist.\n\n When run_stale_ancestors is true, any stale ancestor transforms will be executed first\n in dependency order. If any ancestor fails, execution stops and remaining ancestors\n are marked as not_run. The target transform will not run if any ancestor failed.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ }, {
+ "in" : "path",
+ "name" : "tx-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
} ],
"responses" : {
"2XX" : {
@@ -34169,7 +34032,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.discovery-response"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.execution-result"
}
}
}
@@ -34181,30 +34044,41 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/transforms" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "run_stale_ancestors" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.flag"
+ }
+ }
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/transforms/{id}/inspect/{lens-id}" : {
- "get" : {
- "operationId" : "get-api-ee-transforms-id-inspect-lens-id",
- "summary" : "GET /api/ee/transforms/{id}/inspect/{lens-id}",
- "description" : "Phase 2: Get full lens contents for a transform.\n Returns sections, cards with dataset_query, and trigger definitions.\n Accepts optional params for drill lenses as query params.",
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/unarchive" : {
+ "post" : {
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-unarchive",
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/unarchive",
+ "description" : "Unmark the given transform for archival. This will recall the last definition it had within the workspace.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
}, {
"in" : "path",
- "name" : "lens-id",
+ "name" : "tx-id",
"required" : true,
"schema" : {
- "type" : "string",
- "minLength" : 1
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
}
} ],
"responses" : {
@@ -34213,7 +34087,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms-inspector.schema.lens"
+ "type" : "null"
}
}
}
@@ -34225,31 +34099,23 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/transforms" ]
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/transforms/{id}/inspect/{lens-id}/query" : {
+ "/api/ee/workspace/{ws-id}/unarchive" : {
"post" : {
- "operationId" : "post-api-ee-transforms-id-inspect-lens-id-query",
- "summary" : "POST /api/ee/transforms/{id}/inspect/{lens-id}/query",
- "description" : "Execute a query in the context of a transform inspector lens.",
+ "operationId" : "post-api-ee-workspace-ws-id-unarchive",
+ "summary" : "POST /api/ee/workspace/{ws-id}/unarchive",
+ "description" : "Restore an archived workspace. Recreates the isolated schema and tables.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "lens-id",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
} ],
"responses" : {
"2XX" : {
@@ -34257,7 +34123,34 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ "type" : "object",
+ "properties" : {
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
+ },
+ "updated_at" : {
+ "type" : "string",
+ "format" : "date-time"
+ }
+ },
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
}
}
}
@@ -34269,47 +34162,204 @@
"description" : "Server error response"
}
},
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/eid-translation/translate" : {
+ "post" : {
+ "operationId" : "post-api-eid-translation-translate",
+ "summary" : "POST /api/eid-translation/translate",
+ "description" : "Translate entity IDs to model IDs.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "entity_ids" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "entity_ids" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/eid-translation" ]
+ }
+ },
+ "/api/email" : {
+ "put" : {
+ "operationId" : "put-api-email",
+ "summary" : "PUT /api/email",
+ "description" : "Update multiple email Settings. You must be a superuser or have `setting` permission to do this.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
- "lens_params" : {
- "oneOf" : [ {
- "type" : "object",
- "additionalProperties" : { }
+ "email-smtp-host" : {
+ "anyOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "query" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }
+ "email-smtp-password" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email-smtp-port" : {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email-smtp-security" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email-smtp-username" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "required" : [ "query" ]
+ }
}
}
}
- },
- "tags" : [ "/api/ee/transforms" ]
- }
- },
- "/api/ee/upload-management/tables" : {
- "get" : {
- "operationId" : "get-api-ee-upload-management-tables",
- "summary" : "GET /api/ee/upload-management/tables",
- "description" : "Get all `Tables` visible to the current user which were created by uploading a file.",
- "parameters" : [ ],
+ },
+ "tags" : [ "/api/email" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-email",
+ "summary" : "DELETE /api/email",
+ "description" : "Clear all email related settings. You must be a superuser or have `setting` permission to do this.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/email" ]
+ }
+ },
+ "/api/email/test" : {
+ "post" : {
+ "operationId" : "post-api-email-test",
+ "summary" : "POST /api/email/test",
+ "description" : "Send a test email using the SMTP Settings. You must be a superuser or have `setting` permission to do this.\n Returns `{:ok true}` if we were able to send the message successfully, otherwise a standard 400 error response.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/email" ]
+ }
+ },
+ "/api/embed/card/{token}" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token",
+ "summary" : "GET /api/embed/card/{token}",
+ "description" : "Fetch a Card via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}}",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/params/{param-key}/remapping" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-remapping",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/remapping",
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -34321,34 +34371,36 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/upload-management" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/upload-management/tables/{id}" : {
- "delete" : {
- "operationId" : "delete-api-ee-upload-management-tables-id",
- "summary" : "DELETE /api/ee/upload-management/tables/{id}",
- "description" : "Delete the uploaded table from the database, optionally archiving cards for which it is the primary source.",
+ "/api/embed/card/{token}/params/{param-key}/search/{prefix}" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-params-param-key-search-prefix",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/search/{prefix}",
+ "description" : "Embedded version of chain filter search endpoint.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "token",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "type" : "string"
+ }
}, {
- "in" : "query",
- "name" : "archive-cards",
- "required" : false,
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
}
} ],
"responses" : {
@@ -34362,70 +34414,33 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/upload-management" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace" : {
+ "/api/embed/card/{token}/params/{param-key}/values" : {
"get" : {
- "operationId" : "get-api-ee-workspace",
- "summary" : "GET /api/ee/workspace",
- "description" : "Get a list of all workspaces",
- "parameters" : [ ],
+ "operationId" : "get-api-embed-card-token-params-param-key-values",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/values",
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "items" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
- },
- "updated_at" : {
- "type" : "string",
- "format" : "date-time"
- }
- },
- "required" : [ "id", "database_id", "name", "status", "updated_at" ],
- "additionalProperties" : false
- }
- },
- "limit" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "offset" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "items", "limit", "offset" ],
- "additionalProperties" : false
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34434,50 +34449,25 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
- },
- "post" : {
- "operationId" : "post-api-ee-workspace",
- "summary" : "POST /api/ee/workspace",
- "description" : "Create a new workspace\n\n Potential payload:\n {:name \"a\" :database_id 2}}",
- "parameters" : [ ],
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/query" : {
+ "get" : {
+ "operationId" : "get-api-embed-card-token-query",
+ "summary" : "GET /api/embed/card/{token}/query",
+ "description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "collection_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "created_at" : {
- "type" : "string",
- "format" : "date-time"
- },
- "database_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
- },
- "updated_at" : {
- "type" : "string",
- "format" : "date-time"
- }
- },
- "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34486,127 +34476,48 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- }
- }
- }
- }
- }
- },
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/checkout" : {
+ "/api/embed/card/{token}/query/{export-format}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-checkout",
- "summary" : "GET /api/ee/workspace/checkout",
- "description" : "Get checkout status for a global transform.\n\n Returns:\n - checkout_disabled: Why this transform cannot be checked out (nil if allowed)\n - workspaces: All workspaces for this transform's database, with checkout status\n - transforms: (DEPRECATED) Use :workspaces instead",
+ "operationId" : "get-api-embed-card-token-query-export-format",
+ "summary" : "GET /api/embed/card/{token}/query/{export-format}",
+ "description" : "Like `GET /api/embed/card/query`, but returns the results as a file in the specified format.",
"parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
+ }
+ }, {
"in" : "query",
- "name" : "transform-id",
+ "name" : "format_rows",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "pivot_results",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "checkout_disabled" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "mbql", "card-reference", "unknown-type" ]
- }, {
- "type" : "null"
- } ]
- },
- "transforms" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- },
- "name" : {
- "type" : "string"
- },
- "workspace" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name" ]
- }
- },
- "required" : [ "id", "name", "workspace" ]
- }
- },
- "workspaces" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "existing" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "ref_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
- },
- "required" : [ "ref_id", "name" ]
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
- }
- },
- "required" : [ "id", "name", "status", "existing" ]
- }
- }
- },
- "required" : [ "checkout_disabled", "workspaces", "transforms" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34615,63 +34526,25 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/database" : {
+ "/api/embed/dashboard/{token}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-database",
- "summary" : "GET /api/ee/workspace/database",
- "description" : "Get a list supported databases, and whether they're enabled and have required permissions.",
- "parameters" : [ ],
+ "operationId" : "get-api-embed-dashboard-token",
+ "summary" : "GET /api/embed/dashboard/{token}",
+ "description" : "Fetch a Dashboard via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:dashboard <dashboard-id>}}",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "databases" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "enabled" : {
- "type" : "boolean"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string"
- },
- "permissions_status" : {
- "type" : "object",
- "properties" : {
- "checked_at" : {
- "type" : "string"
- },
- "error" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string"
- }
- },
- "required" : [ "status", "checked_at" ]
- }
- },
- "required" : [ "id", "name", "enabled" ]
- }
- }
- },
- "required" : [ "databases" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34680,18 +34553,34 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/enabled" : {
+ "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-enabled",
- "summary" : "GET /api/ee/workspace/enabled",
- "description" : "Test whether the current user can use Workspaces. Optionally takes a specific database.\n Factors include: driver support, database user privileges, metabase permissions.",
+ "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id",
+ "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
"parameters" : [ {
- "in" : "query",
- "name" : "database-id",
- "required" : false,
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
@@ -34700,23 +34589,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "reason" : {
- "type" : "string"
- },
- "supported" : {
- "type" : "boolean"
- }
- },
- "required" : [ "supported" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34725,61 +34598,66 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/{ws-id}" : {
+ "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-ws-id",
- "summary" : "GET /api/ee/workspace/{ws-id}",
- "description" : "Get a single workspace by ID",
+ "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id-export-format",
+ "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key` return the data in one of the export formats",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "collection_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "created_at" : {
- "type" : "string",
- "format" : "date-time"
- },
- "database_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
- },
- "updated_at" : {
- "type" : "string",
- "format" : "date-time"
- }
- },
- "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
- }
- }
- }
+ }, {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
+ }
+ }, {
+ "in" : "query",
+ "name" : "format_rows",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "pivot_results",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34788,59 +34666,33 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
- },
- "put" : {
- "operationId" : "put-api-ee-workspace-ws-id",
- "summary" : "PUT /api/ee/workspace/{ws-id}",
- "description" : "Update simple workspace properties.\n\n Can set database_id only on uninitialized workspaces.",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/dashboard/{token}/params/{param-key}/remapping" : {
+ "get" : {
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-remapping",
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/remapping",
+ "description" : "Embedded version of the remapped dashboard param value endpoint.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "token",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "collection_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "created_at" : {
- "type" : "string",
- "format" : "date-time"
- },
- "database_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
- },
- "updated_at" : {
- "type" : "string",
- "format" : "date-time"
- }
- },
- "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34849,57 +34701,41 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "database_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "additionalProperties" : false
- }
- }
- }
- },
- "tags" : [ "/api/ee/workspace" ]
- },
- "delete" : {
- "operationId" : "delete-api-ee-workspace-ws-id",
- "summary" : "DELETE /api/ee/workspace/{ws-id}",
- "description" : "Delete a workspace and all its contents, including mirrored entities.",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
+ "get" : {
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-search-prefix",
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/search/{prefix}",
+ "description" : "Embedded version of chain filter search endpoint.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "token",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "ok" : {
- "const" : true
- }
- },
- "required" : [ "ok" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34908,61 +34744,33 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/{ws-id}/archive" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-archive",
- "summary" : "POST /api/ee/workspace/{ws-id}/archive",
- "description" : "Archive a workspace. Deletes the isolated schema and tables, but preserves mirrored entities.",
+ "/api/embed/dashboard/{token}/params/{param-key}/values" : {
+ "get" : {
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-values",
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/values",
+ "description" : "Embedded version of chain filter values endpoint.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "token",
"required" : true,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "collection_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "created_at" : {
- "type" : "string",
- "format" : "date-time"
- },
- "database_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
- },
- "updated_at" : {
- "type" : "string",
- "format" : "date-time"
- }
- },
- "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -34971,67 +34779,25 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/{ws-id}/external/transform" : {
+ "/api/embed/pivot/card/{token}/query" : {
"get" : {
- "operationId" : "get-api-ee-workspace-ws-id-external-transform",
- "summary" : "GET /api/ee/workspace/{ws-id}/external/transform",
- "description" : "Get transforms that are external to the workspace, i.e. no matching workspace_transform row exists.",
+ "operationId" : "get-api-embed-pivot-card-token-query",
+ "summary" : "GET /api/embed/pivot/card/{token}/query",
+ "description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "token",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "query",
- "name" : "database-id",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ "type" : "string"
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "transforms" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "checkout_disabled" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- },
- "source_type" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name", "source_type", "checkout_disabled" ]
- }
- }
- },
- "required" : [ "transforms" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35040,17 +34806,33 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/{ws-id}/graph" : {
+ "/api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-ws-id-graph",
- "summary" : "GET /api/ee/workspace/{ws-id}/graph",
- "description" : "Display the dependency graph between the Changeset and the (potentially external) entities that they depend on.",
+ "operationId" : "get-api-embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
+ "summary" : "GET /api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "card-id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -35060,78 +34842,7 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "edges" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "from_entity_id" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- } ]
- },
- "from_entity_type" : {
- "type" : "string"
- },
- "to_entity_id" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- } ]
- },
- "to_entity_type" : {
- "type" : "string"
- }
- },
- "required" : [ "from_entity_id", "from_entity_type", "to_entity_id", "to_entity_type" ]
- }
- },
- "nodes" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "object",
- "properties" : { }
- },
- "dependents_count" : {
- "type" : "object",
- "additionalProperties" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "id" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- } ]
- },
- "type" : {
- "type" : "string",
- "enum" : [ "input-table", "external-transform", "workspace-transform" ]
- }
- },
- "required" : [ "id", "type", "dependents_count", "data" ]
- }
- }
- },
- "required" : [ "nodes", "edges" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35140,83 +34851,71 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/{ws-id}/input/grant" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-input-grant",
- "summary" : "POST /api/ee/workspace/{ws-id}/input/grant",
- "description" : "Grant read access to input tables by table coordinates. Superuser only.\n Idempotent - returns which tables were already granted vs newly granted.",
+ "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
+ "get" : {
+ "operationId" : "get-api-embed-tiles-card-token-zoom-x-y",
+ "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
+ "description" : "Generates a single tile image for an embedded Card using the map visualization.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "token",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ "type" : "string"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "already_granted" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "db_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "table" : {
- "type" : "string"
- }
- },
- "required" : [ "db_id", "schema", "table" ]
- }
- },
- "newly_granted" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "db_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "table" : {
- "type" : "string"
- }
- },
- "required" : [ "db_id", "schema", "table" ]
- }
- }
- },
- "required" : [ "already_granted", "newly_granted" ]
- }
- }
- }
+ }, {
+ "in" : "path",
+ "name" : "zoom",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "x",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "y",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ },
+ "description" : "value must be a valid JSON string."
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35225,93 +34924,89 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "tables" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "db_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "table" : {
- "type" : "string"
- }
- },
- "required" : [ "db_id", "schema", "table" ]
- }
- }
- },
- "required" : [ "tables" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/{ws-id}/input/pending" : {
+ "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-ws-id-input-pending",
- "summary" : "GET /api/ee/workspace/{ws-id}/input/pending",
- "description" : "List all input tables that haven't been granted access yet, excluding tables shadowed by workspace outputs.",
+ "operationId" : "get-api-embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
+ "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
+ "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "token",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "zoom",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "x",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "path",
+ "name" : "y",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ },
+ "description" : "value must be an integer."
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ },
+ "description" : "value must be a valid JSON string."
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "inputs" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "db_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "table" : {
- "type" : "string"
- }
- },
- "required" : [ "db_id", "schema", "table" ]
- }
- }
- },
- "required" : [ "inputs" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35320,91 +35015,35 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/workspace/{ws-id}/log" : {
+ "/api/field/{id}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-ws-id-log",
- "summary" : "GET /api/ee/workspace/{ws-id}/log",
- "description" : "Get workspace creation status and recent log entries for polling during async setup",
+ "operationId" : "get-api-field-id",
+ "summary" : "GET /api/field/{id}",
+ "description" : "Get `Field` with ID.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "include_editable_data_model",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "last_completed_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "logs" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "completed_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "description" : { },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "started_at" : { },
- "status" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "task" : {
- "type" : "string"
- },
- "updated_at" : { }
- },
- "required" : [ "id", "task", "description", "started_at", "updated_at", "completed_at", "status", "message" ]
- }
- },
- "status" : {
- "type" : "string",
- "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
- },
- "updated_at" : { },
- "workspace_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
- },
- "required" : [ "workspace_id", "status", "updated_at", "last_completed_at", "logs" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35413,103 +35052,25 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
- }
- },
- "/api/ee/workspace/{ws-id}/merge" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-merge",
- "summary" : "POST /api/ee/workspace/{ws-id}/merge",
- "description" : "This will:\n 1. Update original transforms with workspace versions\n 2. Archive the workspace and clean up isolated resources\n Returns a report of merged entities, or error in errors key.\n\n Request body may include:\n - commit-message: A description of what changes are being merged (optional, will be required in future)",
+ "tags" : [ "/api/field" ]
+ },
+ "put" : {
+ "operationId" : "put-api-field-id",
+ "summary" : "PUT /api/field/{id}",
+ "description" : "Update `Field` with ID.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "anyOf" : [ {
- "type" : "object",
- "properties" : {
- "errors" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "global_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "op" : {
- "type" : "string",
- "enum" : [ "create", "delete", "update", "noop" ]
- },
- "ref_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
- },
- "required" : [ "op", "ref_id" ]
- }
- },
- "merged" : {
- "type" : "object",
- "properties" : {
- "transforms" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "global_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "op" : {
- "type" : "string",
- "enum" : [ "create", "delete", "update", "noop" ]
- },
- "ref_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
- },
- "required" : [ "op", "ref_id" ]
- }
- }
- },
- "required" : [ "transforms" ]
- },
- "workspace" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "name" ]
- }
- },
- "required" : [ "merged", "errors", "workspace" ]
- }, {
- "type" : "string"
- } ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35524,26 +35085,119 @@
"schema" : {
"type" : "object",
"properties" : {
- "commit-message" : {
- "type" : "string",
- "minLength" : 1
+ "points_of_interest" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visibility_type" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "retired", "sensitive", "normal", "hidden", "details-only" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "coercion_strategy" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid coercion strategy (keyword or string)."
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "json_unfolding" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid field semantic or relation type (keyword or string)."
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "has_field_values" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "nfc_path" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "caveats" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target_field_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
}
}
}
}
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/workspace/{ws-id}/problem" : {
- "get" : {
- "operationId" : "get-api-ee-workspace-ws-id-problem",
- "summary" : "GET /api/ee/workspace/{ws-id}/problem",
- "description" : "Detect problems in the workspace that would affect downstream transforms after merge.\n\n Returns a list of problems, each with:\n - category: the problem category (e.g. 'unused', 'internal-downstream', 'external-downstream')\n - problem: the specific problem (e.g. 'not-run', 'stale', 'removed-field')\n - severity: :error, :warning, or :info\n - block-merge: whether this problem prevents merging\n - data: extra information, shape depends on the problem type\n\n See `metabase-enterprise.workspaces.types/problem-types` for the full list.",
+ "/api/field/{id}/dimension" : {
+ "post" : {
+ "operationId" : "post-api-field-id-dimension",
+ "summary" : "POST /api/field/{id}/dimension",
+ "description" : "Sets the dimension for the given field at ID",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -35553,17 +35207,63 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.problem"
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "human_readable_field_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "internal", "external" ]
}
- }
+ },
+ "required" : [ "type", "name" ]
}
}
+ }
+ },
+ "tags" : [ "/api/field" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-field-id-dimension",
+ "summary" : "DELETE /api/field/{id}/dimension",
+ "description" : "Remove the dimension associated to field at ID",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35572,32 +35272,27 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/workspace/{ws-id}/query" : {
+ "/api/field/{id}/discard_values" : {
"post" : {
- "operationId" : "post-api-ee-workspace-ws-id-query",
- "summary" : "POST /api/ee/workspace/{ws-id}/query",
- "description" : "Execute an arbitrary SQL query in the workspace's isolated database context.\n Table references are remapped to isolated workspace tables.\n Returns the first 2000 rows of query results.",
+ "operationId" : "post-api-field-id-discard_values",
+ "summary" : "POST /api/field/{id}/discard_values",
+ "description" : "Discard the FieldValues belonging to this Field. Only applies to fields that have FieldValues. If this Field's\n Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.query-result"
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35606,69 +35301,27 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "sql" : {
- "type" : "string",
- "minLength" : 1
- }
- },
- "required" : [ "sql" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/workspace/{ws-id}/run" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-run",
- "summary" : "POST /api/ee/workspace/{ws-id}/run",
- "description" : "Execute all transforms in the workspace in dependency order.\n Returns which transforms succeeded, failed, and were not run.",
+ "/api/field/{id}/related" : {
+ "get" : {
+ "operationId" : "get-api-field-id-related",
+ "summary" : "GET /api/field/{id}/related",
+ "description" : "Return related entities.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "failed" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
- },
- "not_run" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
- },
- "succeeded" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
- }
- },
- "required" : [ "succeeded", "failed", "not_run" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35677,149 +35330,44 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "stale_only" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.flag"
- }
- }
- }
- }
- }
- },
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/workspace/{ws-id}/table" : {
+ "/api/field/{id}/remapping/{remapped-id}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-ws-id-table",
- "summary" : "GET /api/ee/workspace/{ws-id}/table",
- "description" : "Get workspace tables",
+ "operationId" : "get-api-field-id-remapping-remapped-id",
+ "summary" : "GET /api/field/{id}/remapping/{remapped-id}",
+ "description" : "Fetch remapped Field values.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "remapped-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "inputs" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "db_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "table" : {
- "type" : "string"
- },
- "table_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "db_id", "schema", "table", "table_id" ]
- }
- },
- "outputs" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "db_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "global" : {
- "type" : "object",
- "properties" : {
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "table" : {
- "type" : "string"
- },
- "table_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "transform_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "transform_id", "schema", "table", "table_id" ]
- },
- "isolated" : {
- "type" : "object",
- "properties" : {
- "schema" : {
- "type" : "string"
- },
- "table" : {
- "type" : "string"
- },
- "table_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "transform_id" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- } ]
- }
- },
- "required" : [ "transform_id", "schema", "table", "table_id" ]
- }
- },
- "required" : [ "db_id", "global", "isolated" ]
- }
- }
- },
- "required" : [ "inputs", "outputs" ],
- "additionalProperties" : false
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35828,98 +35376,27 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/workspace/{ws-id}/transform" : {
+ "/api/field/{id}/rescan_values" : {
"post" : {
- "operationId" : "post-api-ee-workspace-ws-id-transform",
- "summary" : "POST /api/ee/workspace/{ws-id}/transform",
- "description" : "Add another transform to the Changeset. This could be a fork of an existing global transform, or something new.",
+ "operationId" : "post-api-field-id-rescan_values",
+ "summary" : "POST /api/field/{id}/rescan_values",
+ "description" : "Manually trigger an update for the FieldValues for this Field. Only applies to Fields that are eligible for\n FieldValues.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "last_run_at" : { },
- "target_stale" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "last_run_status" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "workspace_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "updated_at" : { },
- "archived_at" : { },
- "source" : {
- "type" : "object",
- "properties" : { }
- },
- "last_run_message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "target" : {
- "type" : "object",
- "properties" : { }
- },
- "created_at" : { },
- "global_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "creator_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "ref_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "ref_id", "global_id", "name", "description", "source", "target", "target_stale", "workspace_id", "creator_id", "archived_at", "created_at", "updated_at", "last_run_at", "last_run_status", "last_run_message" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -35928,160 +35405,44 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "source" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "query" : {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
- },
- "type" : {
- "const" : "query"
- }
- },
- "required" : [ "type", "query" ]
- }, {
- "type" : "object",
- "properties" : {
- "body" : {
- "type" : "string"
- },
- "source-database" : {
- "type" : "integer"
- },
- "source-tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-base.util.source-table-entry"
- }
- },
- "type" : {
- "const" : "python"
- }
- },
- "required" : [ "source-tables", "type", "body" ],
- "additionalProperties" : false
- } ]
- },
- "target" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "table_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "type" : "string",
- "enum" : [ "table" ]
- }
- },
- "required" : [ "type", "name" ],
- "additionalProperties" : false
- }
- },
- "required" : [ "name", "source", "target" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/workspace" ]
- },
+ "tags" : [ "/api/field" ]
+ }
+ },
+ "/api/field/{id}/search/{search-id}" : {
"get" : {
- "operationId" : "get-api-ee-workspace-ws-id-transform",
- "summary" : "GET /api/ee/workspace/{ws-id}/transform",
- "description" : "Get all transforms in a workspace.",
+ "operationId" : "get-api-field-id-search-search-id",
+ "summary" : "GET /api/field/{id}/search/{search-id}",
+ "description" : "Search for values of a Field with `search-id` that start with `value`. See docstring for\n [[metabase.parameters.field/search-values]] for a more detailed explanation.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "transforms" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "creator_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "global_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "ref_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- },
- "source_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "ref_id", "global_id", "name", "source_type", "creator_id" ],
- "additionalProperties" : false
- }
- }
- },
- "required" : [ "transforms" ]
- }
- }
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "search-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : false,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36090,52 +35451,27 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/workspace/{ws-id}/transform/validate/target" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-transform-validate-target",
- "summary" : "POST /api/ee/workspace/{ws-id}/transform/validate/target",
- "description" : "Validate the target table for a workspace transform",
+ "/api/field/{id}/summary" : {
+ "get" : {
+ "operationId" : "get-api-field-id-summary",
+ "summary" : "GET /api/field/{id}/summary",
+ "description" : "Get the count and distinct count of `Field` with ID.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "query",
- "name" : "transform-id",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "body" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "anyOf" : [ { }, { } ]
- } ]
- },
- "status" : {
- "type" : "integer"
- }
- },
- "required" : [ "status", "body" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36144,142 +35480,27 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "db_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "target" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "type" : "string"
- }
- },
- "required" : [ "type", "schema", "name" ]
- }
- },
- "required" : [ "target" ]
- }
- }
- }
- },
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/workspace/{ws-id}/transform/{tx-id}" : {
+ "/api/field/{id}/values" : {
"get" : {
- "operationId" : "get-api-ee-workspace-ws-id-transform-tx-id",
- "summary" : "GET /api/ee/workspace/{ws-id}/transform/{tx-id}",
- "description" : "Get a specific transform in a workspace.",
+ "operationId" : "get-api-field-id-values",
+ "summary" : "GET /api/field/{id}/values",
+ "description" : "If a Field's value of `has_field_values` is `:list`, return a list of all the distinct values of the Field (or\n remapped Field), and (if defined by a User) a map of human-readable remapped values. If `has_field_values` is not\n `:list`, checks whether we should create FieldValues for this Field; if so, creates and returns them.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "path",
- "name" : "tx-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "last_run_at" : { },
- "target_stale" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "last_run_status" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "workspace_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "updated_at" : { },
- "archived_at" : { },
- "source" : {
- "type" : "object",
- "properties" : { }
- },
- "last_run_message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "target" : {
- "type" : "object",
- "properties" : { }
- },
- "created_at" : { },
- "global_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "creator_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "ref_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "ref_id", "global_id", "name", "description", "source", "target", "target_stale", "workspace_id", "creator_id", "archived_at", "created_at", "updated_at", "last_run_at", "last_run_status", "last_run_message" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36288,103 +35509,72 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/field" ]
},
- "put" : {
- "operationId" : "put-api-ee-workspace-ws-id-transform-tx-id",
- "summary" : "PUT /api/ee/workspace/{ws-id}/transform/{tx-id}",
- "description" : "Update or create a transform in a workspace.\n If the transform exists, updates it. If it doesn't exist, creates a new transform with the provided ref_id.\n For creation, name, source, and target are required.",
+ "post" : {
+ "operationId" : "post-api-field-id-values",
+ "summary" : "POST /api/field/{id}/values",
+ "description" : "Update the fields values and human-readable values for a `Field` whose semantic type is\n `category`/`city`/`state`/`country` or whose base type is `type/Boolean`. The human-readable values are optional.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "path",
- "name" : "tx-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "last_run_at" : { },
- "target_stale" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "last_run_status" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "workspace_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "updated_at" : { },
- "archived_at" : { },
- "source" : {
- "type" : "object",
- "properties" : { }
- },
- "last_run_message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "target" : {
- "type" : "object",
- "properties" : { }
- },
- "created_at" : { },
- "global_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "creator_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "ref_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "values" : {
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ { } ]
}, {
- "type" : "null"
+ "type" : "array",
+ "prefixItems" : [ { }, {
+ "type" : "string",
+ "minLength" : 1
+ } ]
} ]
}
- },
- "required" : [ "ref_id", "global_id", "name", "description", "source", "target", "target_stale", "workspace_id", "creator_id", "archived_at", "created_at", "updated_at", "last_run_at", "last_run_status", "last_run_message" ]
- }
+ }
+ },
+ "required" : [ "values" ]
}
}
+ }
+ },
+ "tags" : [ "/api/field" ]
+ }
+ },
+ "/api/frontend-errors" : {
+ "post" : {
+ "operationId" : "post-api-frontend-errors",
+ "summary" : "POST /api/frontend-errors",
+ "description" : "Endpoint for the frontend to report errors. Increments a Prometheus counter\n with the given `type` label.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36399,120 +35589,35 @@
"schema" : {
"type" : "object",
"properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "source" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "query" : {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
- },
- "type" : {
- "const" : "query"
- }
- },
- "required" : [ "type", "query" ]
- }, {
- "type" : "object",
- "properties" : {
- "body" : {
- "type" : "string"
- },
- "source-database" : {
- "type" : "integer"
- },
- "source-tables" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.transforms-base.util.source-table-entry"
- }
- },
- "type" : {
- "const" : "python"
- }
- },
- "required" : [ "source-tables", "type", "body" ],
- "additionalProperties" : false
- } ]
- },
- "target" : {
- "type" : "object",
- "properties" : {
- "database" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
- "table_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "type" : "string",
- "enum" : [ "table" ]
- }
- },
- "required" : [ "type", "name" ],
- "additionalProperties" : false
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.frontend-errors.api.frontend-error-type"
}
- }
+ },
+ "required" : [ "type" ]
}
}
}
},
- "tags" : [ "/api/ee/workspace" ]
- },
- "delete" : {
- "operationId" : "delete-api-ee-workspace-ws-id-transform-tx-id",
- "summary" : "DELETE /api/ee/workspace/{ws-id}/transform/{tx-id}",
- "description" : "Discard a transform from the changeset.\n Equivalent to resetting a checked-out transform to its global definition, or deleting a provisional transform.",
+ "tags" : [ "/api/frontend-errors" ]
+ }
+ },
+ "/api/geojson" : {
+ "get" : {
+ "operationId" : "get-api-geojson",
+ "summary" : "GET /api/geojson",
+ "description" : "Load a custom GeoJSON file based on a URL or file path provided as a query parameter.\n This behaves similarly to /api/geojson/:key but doesn't require the custom map to be saved to the DB first.",
"parameters" : [ {
- "in" : "path",
- "name" : "ws-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "path",
- "name" : "tx-id",
+ "in" : "query",
+ "name" : "url",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ "type" : "string",
+ "minLength" : 1
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "null"
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36521,39 +35626,26 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/geojson" ]
}
},
- "/api/ee/workspace/{ws-id}/transform/{tx-id}/archive" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-archive",
- "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/archive",
- "description" : "Mark the given transform to be archived when the workspace is merged.\n For provisional transforms we will skip even creating it in the first place.",
+ "/api/geojson/{key}" : {
+ "get" : {
+ "operationId" : "get-api-geojson-key",
+ "summary" : "GET /api/geojson/{key}",
+ "description" : "Fetch a custom GeoJSON file as defined in the [[metabase.geojson.settings/custom-geojson]] setting. (This just acts\n as a simple proxy for the file specified for `key`).",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "path",
- "name" : "tx-id",
+ "name" : "key",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ "type" : "string",
+ "minLength" : 1
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "null"
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36562,39 +35654,36 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/geojson" ]
}
},
- "/api/ee/workspace/{ws-id}/transform/{tx-id}/dry-run" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-dry-run",
- "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/dry-run",
- "description" : "Dry-run a transform in a workspace without persisting to the target table.\n\n Returns the first 2000 rows of transform output for preview purposes.\n Does not update last_run_at or create any database tables.\n\n When run_stale_ancestors is true, any stale ancestor transforms will be executed first\n in dependency order (these ARE persisted). If any ancestor fails, execution stops and\n the dry-run will not proceed.",
- "parameters" : [ {
- "in" : "path",
- "name" : "ws-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "path",
- "name" : "tx-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ "/api/glossary" : {
+ "get" : {
+ "operationId" : "get-api-glossary",
+ "summary" : "GET /api/glossary",
+ "description" : "Fetch all glossary entries, optionally filtered by search term.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- } ],
+ },
+ "tags" : [ "/api/glossary" ]
+ },
+ "post" : {
+ "operationId" : "post-api-glossary",
+ "summary" : "POST /api/glossary",
+ "description" : "Create a new glossary entry.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.query-result"
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36609,67 +35698,41 @@
"schema" : {
"type" : "object",
"properties" : {
- "run_stale_ancestors" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.flag"
+ "definition" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "term" : {
+ "type" : "string",
+ "minLength" : 1
}
- }
+ },
+ "required" : [ "term", "definition" ]
}
}
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/glossary" ]
}
},
- "/api/ee/workspace/{ws-id}/transform/{tx-id}/merge" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-merge",
- "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/merge",
- "description" : "Merge single transform from workspace back to the core. If workspace transform is archived\n the corresponding core transform is deleted.\n\n Request body may include:\n - commit-message: A description of what changes are being merged (optional, will be required in future)",
+ "/api/glossary/{id}" : {
+ "put" : {
+ "operationId" : "put-api-glossary-id",
+ "summary" : "PUT /api/glossary/{id}",
+ "description" : "Update an existing glossary entry.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "path",
- "name" : "tx-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "global_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }, {
- "type" : "null"
- } ]
- },
- "message" : {
- "type" : "string"
- },
- "op" : {
- "type" : "string",
- "enum" : [ "create", "delete", "update", "noop" ]
- },
- "ref_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
- },
- "required" : [ "op", "global_id", "ref_id" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36684,48 +35747,59 @@
"schema" : {
"type" : "object",
"properties" : {
- "commit-message" : {
+ "definition" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "term" : {
"type" : "string",
"minLength" : 1
}
- }
+ },
+ "required" : [ "term", "definition" ]
}
}
}
},
- "tags" : [ "/api/ee/workspace" ]
- }
- },
- "/api/ee/workspace/{ws-id}/transform/{tx-id}/run" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-run",
- "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/run",
- "description" : "Run a transform in a workspace.\n\n App DB changes are rolled back. Warehouse DB changes persist.\n\n When run_stale_ancestors is true, any stale ancestor transforms will be executed first\n in dependency order. If any ancestor fails, execution stops and remaining ancestors\n are marked as not_run. The target transform will not run if any ancestor failed.",
+ "tags" : [ "/api/glossary" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-glossary-id",
+ "summary" : "DELETE /api/glossary/{id}",
+ "description" : "Delete a glossary entry.",
"parameters" : [ {
"in" : "path",
- "name" : "ws-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "path",
- "name" : "tx-id",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.execution-result"
- }
- }
- }
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/glossary" ]
+ }
+ },
+ "/api/google/settings" : {
+ "put" : {
+ "operationId" : "put-api-google-settings",
+ "summary" : "PUT /api/google/settings",
+ "description" : "Update Google Sign-In related settings. You must be a superuser to do this.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36740,47 +35814,44 @@
"schema" : {
"type" : "object",
"properties" : {
- "run_stale_ancestors" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.flag"
+ "google-auth-auto-create-accounts-domain" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "google-auth-client-id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "google-auth-enabled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}
}
}
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "tags" : [ "/api/google" ]
}
},
- "/api/ee/workspace/{ws-id}/transform/{tx-id}/unarchive" : {
- "post" : {
- "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-unarchive",
- "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/unarchive",
- "description" : "Unmark the given transform for archival. This will recall the last definition it had within the workspace.",
- "parameters" : [ {
- "in" : "path",
- "name" : "ws-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- }
- }, {
- "in" : "path",
- "name" : "tx-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
- }
- } ],
+ "/api/ldap/settings" : {
+ "put" : {
+ "operationId" : "put-api-ldap-settings",
+ "summary" : "PUT /api/ldap/settings",
+ "description" : "Update LDAP related settings. You must be a superuser to do this.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "null"
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36789,24 +35860,55 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "ldap-enabled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-host" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-password" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-port" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ldap" ]
}
},
- "/api/ee/workspace/{ws-id}/unarchive" : {
+ "/api/llm/extract-tables" : {
"post" : {
- "operationId" : "post-api-ee-workspace-ws-id-unarchive",
- "summary" : "POST /api/ee/workspace/{ws-id}/unarchive",
- "description" : "Restore an archived workspace. Recreates the isolated schema and tables.",
- "parameters" : [ {
- "in" : "path",
- "name" : "ws-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "operationId" : "post-api-llm-extract-tables",
+ "summary" : "POST /api/llm/extract-tables",
+ "description" : "Parse SQL and return referenced tables with their columns.\n\n Uses Macaw to parse the SQL, resolves table names to IDs,\n and returns permission-filtered tables with column metadata.\n\n This is a lightweight endpoint that does not trigger fingerprinting\n or field value fetching.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response",
@@ -36815,32 +35917,94 @@
"schema" : {
"type" : "object",
"properties" : {
- "collection_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "created_at" : {
- "type" : "string",
- "format" : "date-time"
- },
- "database_id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
- },
- "name" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ]
- },
- "updated_at" : {
- "type" : "string",
- "format" : "date-time"
+ "tables" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "database_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target" : {
+ "type" : "object",
+ "properties" : {
+ "field_name" : {
+ "type" : "string"
+ },
+ "table_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_name", "field_name" ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ]
+ }
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "columns" ]
+ }
}
},
- "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ]
+ "required" : [ "tables" ]
}
}
}
@@ -36852,18 +36016,139 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/ee/workspace" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "sql" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "database_id", "sql" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/llm" ]
}
},
- "/api/eid-translation/translate" : {
+ "/api/llm/generate-sql" : {
"post" : {
- "operationId" : "post-api-eid-translation-translate",
- "summary" : "POST /api/eid-translation/translate",
- "description" : "Translate entity IDs to model IDs.",
+ "operationId" : "post-api-llm-generate-sql",
+ "summary" : "POST /api/llm/generate-sql",
+ "description" : "Generate SQL from a natural language prompt.\n\n Requires:\n - LLM to be configured (Anthropic API key set in admin settings)\n - At least one table reference (explicit @mention or implicit from source_sql)\n - A database_id parameter\n\n Returns generated SQL and the list of tables used for context.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "referenced_entities" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "database_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target" : {
+ "type" : "object",
+ "properties" : {
+ "field_name" : {
+ "type" : "string"
+ },
+ "table_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_name", "field_name" ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ]
+ }
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "model" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "model", "id", "name", "columns" ]
+ }
+ },
+ "sql" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "sql", "referenced_entities" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -36878,92 +36163,75 @@
"schema" : {
"type" : "object",
"properties" : {
- "entity_ids" : {
- "type" : "object",
- "properties" : { }
+ "database_id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "prompt" : {
+ "type" : "string"
+ },
+ "referenced_entities" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "model" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "model", "id" ]
+ }
+ },
+ "source_sql" : {
+ "type" : "string"
}
},
- "required" : [ "entity_ids" ]
+ "required" : [ "prompt", "database_id" ]
}
}
}
},
- "tags" : [ "/api/eid-translation" ]
+ "tags" : [ "/api/llm" ]
}
},
- "/api/email" : {
- "put" : {
- "operationId" : "put-api-email",
- "summary" : "PUT /api/email",
- "description" : "Update multiple email Settings. You must be a superuser or have `setting` permission to do this.",
+ "/api/llm/list-models" : {
+ "get" : {
+ "operationId" : "get-api-llm-list-models",
+ "summary" : "GET /api/llm/list-models",
+ "description" : "List available LLM models from the configured provider.\n\n Requires LLM to be configured (Anthropic API key set in admin settings).",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "email-smtp-host" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email-smtp-password" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email-smtp-port" : {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "email-smtp-security" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "models" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ]
+ }
+ }
},
- "email-smtp-username" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
+ "required" : [ "models" ]
}
}
}
- }
- },
- "tags" : [ "/api/email" ]
- },
- "delete" : {
- "operationId" : "delete-api-email",
- "summary" : "DELETE /api/email",
- "description" : "Clear all email related settings. You must be a superuser or have `setting` permission to do this.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -36972,14 +36240,14 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/email" ]
+ "tags" : [ "/api/llm" ]
}
},
- "/api/email/test" : {
+ "/api/logger/adjustment" : {
"post" : {
- "operationId" : "post-api-email-test",
- "summary" : "POST /api/email/test",
- "description" : "Send a test email using the SMTP Settings. You must be a superuser or have `setting` permission to do this.\n Returns `{:ok true}` if we were able to send the message successfully, otherwise a standard 400 error response.",
+ "operationId" : "post-api-logger-adjustment",
+ "summary" : "POST /api/logger/adjustment",
+ "description" : "Temporarily adjust the log levels.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -36992,291 +36260,32 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/email" ]
- }
- },
- "/api/embed/card/{token}" : {
- "get" : {
- "operationId" : "get-api-embed-card-token",
- "summary" : "GET /api/embed/card/{token}",
- "description" : "Fetch a Card via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}}",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/card/{token}/params/{param-key}/remapping" : {
- "get" : {
- "operationId" : "get-api-embed-card-token-params-param-key-remapping",
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/remapping",
- "description" : "Embedded version of api.card filter values endpoint.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/card/{token}/params/{param-key}/search/{prefix}" : {
- "get" : {
- "operationId" : "get-api-embed-card-token-params-param-key-search-prefix",
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/search/{prefix}",
- "description" : "Embedded version of chain filter search endpoint.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- }, {
- "in" : "path",
- "name" : "prefix",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/card/{token}/params/{param-key}/values" : {
- "get" : {
- "operationId" : "get-api-embed-card-token-params-param-key-values",
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/values",
- "description" : "Embedded version of api.card filter values endpoint.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/card/{token}/query" : {
- "get" : {
- "operationId" : "get-api-embed-card-token-query",
- "summary" : "GET /api/embed/card/{token}/query",
- "description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/card/{token}/query/{export-format}" : {
- "get" : {
- "operationId" : "get-api-embed-card-token-query-export-format",
- "summary" : "GET /api/embed/card/{token}/query/{export-format}",
- "description" : "Like `GET /api/embed/card/query`, but returns the results as a file in the specified format.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "export-format",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
- }
- }, {
- "in" : "query",
- "name" : "format_rows",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "pivot_results",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/dashboard/{token}" : {
- "get" : {
- "operationId" : "get-api-embed-dashboard-token",
- "summary" : "GET /api/embed/dashboard/{token}",
- "description" : "Fetch a Dashboard via a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:dashboard <dashboard-id>}}",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "duration" : {
+ "type" : "integer"
+ },
+ "duration_unit" : {
+ "$ref" : "#/components/schemas/metabase.logger.api.time-unit"
+ },
+ "log_levels" : { }
+ },
+ "required" : [ "duration", "duration_unit", "log_levels" ]
+ }
+ }
}
},
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
- "get" : {
- "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id",
- "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "tags" : [ "/api/logger" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-logger-adjustment",
+ "summary" : "DELETE /api/logger/adjustment",
+ "description" : "Undo any log level adjustments.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -37288,63 +36297,15 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
- "get" : {
- "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id-export-format",
- "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key` return the data in one of the export formats",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "export-format",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
- }
- }, {
- "in" : "query",
- "name" : "format_rows",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "pivot_results",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- } ],
+ "tags" : [ "/api/logger" ]
+ }
+ },
+ "/api/logger/logs" : {
+ "get" : {
+ "operationId" : "get-api-logger-logs",
+ "summary" : "GET /api/logger/logs",
+ "description" : "Logs.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -37356,33 +36317,52 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/logger" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/remapping" : {
+ "/api/logger/presets" : {
"get" : {
- "operationId" : "get-api-embed-dashboard-token-params-param-key-remapping",
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/remapping",
- "description" : "Embedded version of the remapped dashboard param value endpoint.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
+ "operationId" : "get-api-logger-presets",
+ "summary" : "GET /api/logger/presets",
+ "description" : "Get all known presets.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "loggers" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "level" : {
+ "$ref" : "#/components/schemas/metabase.logger.api.log-level"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "level" ]
+ }
+ }
+ },
+ "required" : [ "id", "display_name", "loggers" ]
+ }
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -37391,38 +36371,15 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/logger" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
+ "/api/login-history/current" : {
"get" : {
- "operationId" : "get-api-embed-dashboard-token-params-param-key-search-prefix",
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/search/{prefix}",
- "description" : "Embedded version of chain filter search endpoint.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- }, {
- "in" : "path",
- "name" : "prefix",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
+ "operationId" : "get-api-login-history-current",
+ "summary" : "GET /api/login-history/current",
+ "description" : "Fetch recent logins for the current user.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -37434,33 +36391,25 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/login-history" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/values" : {
- "get" : {
- "operationId" : "get-api-embed-dashboard-token-params-param-key-values",
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/values",
- "description" : "Embedded version of chain filter values endpoint.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
+ "/api/measure" : {
+ "post" : {
+ "operationId" : "post-api-measure",
+ "summary" : "POST /api/measure",
+ "description" : "Create a new `Measure`.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -37469,25 +36418,59 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/pivot/card/{token}/query" : {
- "get" : {
- "operationId" : "get-api-embed-pivot-card-token-query",
- "summary" : "GET /api/embed/pivot/card/{token}/query",
- "description" : "Fetch the results of running a Card using a JSON Web Token signed with the `embedding-secret-key`.\n\n Token should have the following format:\n\n {:resource {:question <card-id>}\n :params <parameters>}",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "definition" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "table_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "name", "table_id", "definition" ]
+ }
+ }
}
- } ],
+ },
+ "tags" : [ "/api/measure" ]
+ },
+ "get" : {
+ "operationId" : "get-api-measure",
+ "summary" : "GET /api/measure",
+ "description" : "Fetch *all* `Measures`.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ }
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -37496,33 +36479,51 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/measure" ]
}
},
- "/api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "/api/measure/{id}" : {
"get" : {
- "operationId" : "get-api-embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
- "summary" : "GET /api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
+ "operationId" : "get-api-measure-id",
+ "summary" : "GET /api/measure/{id}",
+ "description" : "Fetch `Measure` with ID.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "dashcard-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
- }, {
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/measure" ]
+ },
+ "put" : {
+ "operationId" : "put-api-measure-id",
+ "summary" : "PUT /api/measure/{id}",
+ "description" : "Update a `Measure` with ID.",
+ "parameters" : [ {
"in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -37532,7 +36533,14 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -37541,63 +36549,81 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "definition" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "revision_message" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ },
+ "required" : [ "revision_message" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/measure" ]
}
},
- "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
+ "/api/measure/{id}/dimension/{dimension-key}/remapping" : {
"get" : {
- "operationId" : "get-api-embed-tiles-card-token-zoom-x-y",
- "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
- "description" : "Generates a single tile image for an embedded Card using the map visualization.",
+ "operationId" : "get-api-measure-id-dimension-dimension-key-remapping",
+ "summary" : "GET /api/measure/{id}/dimension/{dimension-key}/remapping",
+ "description" : "Fetch remapped value for a specific dimension value.\n\n Returns a pair [value, display-name] if remapping exists, or [value] otherwise.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "zoom",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "x",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "integer"
+ "type" : "integer",
+ "minimum" : 1
},
- "description" : "value must be an integer."
+ "description" : "value must be an integer greater than zero."
}, {
"in" : "path",
- "name" : "y",
+ "name" : "dimension-key",
"required" : true,
"schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "description" : "value must be a valid JSON string."
- }, {
- "in" : "query",
- "name" : "latField",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
+ "description" : "value must be a valid UUID."
}, {
"in" : "query",
- "name" : "lonField",
+ "name" : "value",
"required" : true,
"schema" : {
"type" : "string"
@@ -37605,7 +36631,14 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.RemappedValueResponse"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -37614,33 +36647,17 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/measure" ]
}
},
- "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
+ "/api/measure/{id}/dimension/{dimension-key}/search" : {
"get" : {
- "operationId" : "get-api-embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
- "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
- "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
+ "operationId" : "get-api-measure-id-dimension-dimension-key-search",
+ "summary" : "GET /api/measure/{id}/dimension/{dimension-key}/search",
+ "description" : "Search for values of a dimension that contain the query string.\n\n Returns field values matching the search query in the same format as the field values API.",
"parameters" : [ {
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -37649,54 +36666,38 @@
"description" : "value must be an integer greater than zero."
}, {
"in" : "path",
- "name" : "zoom",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "x",
- "required" : true,
- "schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "path",
- "name" : "y",
+ "name" : "dimension-key",
"required" : true,
"schema" : {
- "type" : "integer"
- },
- "description" : "value must be an integer."
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "description" : "value must be a valid JSON string."
- }, {
- "in" : "query",
- "name" : "latField",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
+ "description" : "value must be a valid UUID."
}, {
"in" : "query",
- "name" : "lonField",
+ "name" : "query",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "minLength" : 1
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -37705,14 +36706,14 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/embed" ]
+ "tags" : [ "/api/measure" ]
}
},
- "/api/field/{id}" : {
+ "/api/measure/{id}/dimension/{dimension-key}/values" : {
"get" : {
- "operationId" : "get-api-field-id",
- "summary" : "GET /api/field/{id}",
- "description" : "Get `Field` with ID.",
+ "operationId" : "get-api-measure-id-dimension-dimension-key-values",
+ "summary" : "GET /api/measure/{id}/dimension/{dimension-key}/values",
+ "description" : "Fetch values for a dimension of a measure.\n\n Returns field values in the same format as the field values API:\n - values: list of [value] or [value, display-name] tuples\n - field_id: the underlying field ID\n - has_more_values: boolean indicating if there are more values",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -37723,17 +36724,45 @@
},
"description" : "value must be an integer greater than zero."
}, {
- "in" : "query",
- "name" : "include_editable_data_model",
+ "in" : "path",
+ "name" : "dimension-key",
"required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
- }
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "description" : "value must be a valid UUID."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "has_more_values" : {
+ "type" : "boolean"
+ },
+ "values" : {
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ { }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ { } ]
+ } ]
+ }
+ }
+ },
+ "required" : [ "has_more_values", "values" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -37742,22 +36771,15 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/field" ]
- },
- "put" : {
- "operationId" : "put-api-field-id",
- "summary" : "PUT /api/field/{id}",
- "description" : "Update `Field` with ID.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "tags" : [ "/api/measure" ]
+ }
+ },
+ "/api/metabot/agent-streaming" : {
+ "post" : {
+ "operationId" : "post-api-metabot-agent-streaming",
+ "summary" : "POST /api/metabot/agent-streaming",
+ "description" : "Send a chat message to the LLM via the AI Proxy.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -37775,86 +36797,149 @@
"schema" : {
"type" : "object",
"properties" : {
- "points_of_interest" : {
+ "context" : {
+ "$ref" : "#/components/schemas/metabase.metabot.context.context"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "debug" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "settings" : {
+ "history" : {
"oneOf" : [ {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "$ref" : "#/components/schemas/metabase.metabot.client.schema.messages"
}, {
"type" : "null"
} ]
},
- "visibility_type" : {
+ "message" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "metabot_id" : {
+ "type" : "string"
+ },
+ "profile_id" : {
+ "type" : "string"
+ },
+ "state" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "message", "context", "conversation_id", "history", "state" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot" ]
+ }
+ },
+ "/api/metabot/describe/card" : {
+ "post" : {
+ "operationId" : "post-api-metabot-describe-card",
+ "summary" : "POST /api/metabot/describe/card",
+ "description" : "Summarize a question.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "visualization_settings" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "dataset" : {
"oneOf" : [ {
- "type" : "string",
- "enum" : [ "retired", "sensitive", "normal", "hidden", "details-only" ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "coercion_strategy" : {
+ "dataset_query" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "parameter_mappings" : {
"oneOf" : [ {
- "description" : "value must be a valid coercion strategy (keyword or string)."
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
+ }
}, {
"type" : "null"
} ]
},
- "json_unfolding" : {
+ "collection_position" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "semantic_type" : {
+ "result_metadata" : {
"oneOf" : [ {
- "description" : "value must be a valid field semantic or relation type (keyword or string)."
+ "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
}, {
"type" : "null"
} ]
},
- "has_field_values" : {
+ "collection_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "display_name" : {
+ "cache_ttl" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
}, {
"type" : "null"
} ]
},
- "nfc_path" : {
+ "display" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "parameters" : {
"oneOf" : [ {
"type" : "array",
"items" : {
- "type" : "string",
- "minLength" : 1
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
}, {
"type" : "null"
} ]
},
- "caveats" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- },
"description" : {
"oneOf" : [ {
"type" : "string",
@@ -37862,29 +36947,21 @@
}, {
"type" : "null"
} ]
- },
- "fk_target_field_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
}
- }
+ },
+ "required" : [ "dataset_query", "display", "visualization_settings" ]
}
}
}
},
- "tags" : [ "/api/field" ]
+ "tags" : [ "/api/metabot" ]
}
},
- "/api/field/{id}/dimension" : {
+ "/api/metabot/describe/dashboard/{id}" : {
"post" : {
- "operationId" : "post-api-field-id-dimension",
- "summary" : "POST /api/field/{id}/dimension",
- "description" : "Sets the dimension for the given field at ID",
+ "operationId" : "post-api-metabot-describe-dashboard-id",
+ "summary" : "POST /api/metabot/describe/dashboard/{id}",
+ "description" : "Provide a summary of a dashboard.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -37906,41 +36983,213 @@
"description" : "Server error response"
}
},
+ "tags" : [ "/api/metabot" ]
+ }
+ },
+ "/api/metabot/document/generate-content" : {
+ "post" : {
+ "operationId" : "post-api-metabot-document-generate-content",
+ "summary" : "POST /api/metabot/document/generate-content",
+ "description" : "Create a new piece of content to insert into the document.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
- "human_readable_field_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
+ "instructions" : {
"type" : "string",
"minLength" : 1
},
- "type" : {
+ "references" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "instructions" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/document" ]
+ }
+ },
+ "/api/metabot/document/native-generate-content" : {
+ "post" : {
+ "operationId" : "post-api-metabot-document-native-generate-content",
+ "summary" : "POST /api/metabot/document/native-generate-content",
+ "description" : "Create a new piece of content to insert into the document using the native Clojure agent.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "draft_card" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "database_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "dataset_query" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ },
+ "name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "required" : [ "name", "dataset_query", "database_id", "parameters", "visualization_settings" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "error" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "draft_card", "error", "description" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "instructions" : {
"type" : "string",
- "enum" : [ "internal", "external" ]
+ "minLength" : 1
+ },
+ "references" : {
+ "description" : "Value must be a map.",
+ "type" : "object",
+ "properties" : { }
}
},
- "required" : [ "type", "name" ]
+ "required" : [ "instructions" ]
}
}
}
},
- "tags" : [ "/api/field" ]
- },
- "delete" : {
- "operationId" : "delete-api-field-id-dimension",
- "summary" : "DELETE /api/field/{id}/dimension",
- "description" : "Remove the dimension associated to field at ID",
+ "tags" : [ "/api/metabot/document" ]
+ }
+ },
+ "/api/metabot/feedback" : {
+ "post" : {
+ "operationId" : "post-api-metabot-feedback",
+ "summary" : "POST /api/metabot/feedback",
+ "description" : "Proxy Metabot feedback to Harbormaster, adding the premium embedding token.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot" ]
+ }
+ },
+ "/api/metabot/metabot" : {
+ "get" : {
+ "operationId" : "get-api-metabot-metabot",
+ "summary" : "GET /api/metabot/metabot",
+ "description" : "List configured metabot instances",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/metabot/metabot" ]
+ }
+ },
+ "/api/metabot/metabot/{id}" : {
+ "get" : {
+ "operationId" : "get-api-metabot-metabot-id",
+ "summary" : "GET /api/metabot/metabot/{id}",
+ "description" : "Retrieve one metabot instance",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -37948,8 +37197,7 @@
"schema" : {
"type" : "integer",
"minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ }
} ],
"responses" : {
"2XX" : {
@@ -37962,14 +37210,12 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/field" ]
- }
- },
- "/api/field/{id}/discard_values" : {
- "post" : {
- "operationId" : "post-api-field-id-discard_values",
- "summary" : "POST /api/field/{id}/discard_values",
- "description" : "Discard the FieldValues belonging to this Field. Only applies to fields that have FieldValues. If this Field's\n Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.",
+ "tags" : [ "/api/metabot/metabot" ]
+ },
+ "put" : {
+ "operationId" : "put-api-metabot-metabot-id",
+ "summary" : "PUT /api/metabot/metabot/{id}",
+ "description" : "Update a metabot instance",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -37977,8 +37223,7 @@
"schema" : {
"type" : "integer",
"minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ }
} ],
"responses" : {
"2XX" : {
@@ -37991,14 +37236,37 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/field" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "use_verified_content" : {
+ "type" : "boolean"
+ }
+ },
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/metabot" ]
}
},
- "/api/field/{id}/related" : {
+ "/api/metabot/metabot/{id}/prompt-suggestions" : {
"get" : {
- "operationId" : "get-api-field-id-related",
- "summary" : "GET /api/field/{id}/related",
- "description" : "Return related entities.",
+ "operationId" : "get-api-metabot-metabot-id-prompt-suggestions",
+ "summary" : "GET /api/metabot/metabot/{id}/prompt-suggestions",
+ "description" : "Return the prompt suggestions for the metabot instance with `id`.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -38006,8 +37274,30 @@
"schema" : {
"type" : "integer",
"minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ }
+ }, {
+ "in" : "query",
+ "name" : "sample",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "model",
+ "required" : false,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "metric", "model" ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "model_id",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
} ],
"responses" : {
"2XX" : {
@@ -38020,14 +37310,12 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/field" ]
- }
- },
- "/api/field/{id}/remapping/{remapped-id}" : {
- "get" : {
- "operationId" : "get-api-field-id-remapping-remapped-id",
- "summary" : "GET /api/field/{id}/remapping/{remapped-id}",
- "description" : "Fetch remapped Field values.",
+ "tags" : [ "/api/metabot/metabot" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-metabot-metabot-id-prompt-suggestions",
+ "summary" : "DELETE /api/metabot/metabot/{id}/prompt-suggestions",
+ "description" : "Delete all prompt suggestions for the metabot instance with `id`.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -38035,24 +37323,34 @@
"schema" : {
"type" : "integer",
"minimum" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "description" : "value must be an integer greater than zero."
- }, {
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/metabot/metabot" ]
+ }
+ },
+ "/api/metabot/metabot/{id}/prompt-suggestions/regenerate" : {
+ "post" : {
+ "operationId" : "post-api-metabot-metabot-id-prompt-suggestions-regenerate",
+ "summary" : "POST /api/metabot/metabot/{id}/prompt-suggestions/regenerate",
+ "description" : "Remove any existing prompt suggestions for the Metabot instance with `id` and generate new ones.",
+ "parameters" : [ {
"in" : "path",
- "name" : "remapped-id",
+ "name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
}
} ],
"responses" : {
@@ -38066,14 +37364,14 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/field" ]
+ "tags" : [ "/api/metabot/metabot" ]
}
},
- "/api/field/{id}/rescan_values" : {
- "post" : {
- "operationId" : "post-api-field-id-rescan_values",
- "summary" : "POST /api/field/{id}/rescan_values",
- "description" : "Manually trigger an update for the FieldValues for this Field. Only applies to Fields that are eligible for\n FieldValues.",
+ "/api/metabot/metabot/{id}/prompt-suggestions/{prompt-id}" : {
+ "delete" : {
+ "operationId" : "delete-api-metabot-metabot-id-prompt-suggestions-prompt-id",
+ "summary" : "DELETE /api/metabot/metabot/{id}/prompt-suggestions/{prompt-id}",
+ "description" : "Delete the prompt suggestion with ID `prompt-id` for the metabot instance with `id`.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -38081,8 +37379,15 @@
"schema" : {
"type" : "integer",
"minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ }
+ }, {
+ "in" : "path",
+ "name" : "prompt-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ }
} ],
"responses" : {
"2XX" : {
@@ -38095,41 +37400,108 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/field" ]
+ "tags" : [ "/api/metabot/metabot" ]
+ }
+ },
+ "/api/metabot/slack/events" : {
+ "post" : {
+ "operationId" : "post-api-metabot-slack-events",
+ "summary" : "POST /api/metabot/slack/events",
+ "description" : "Respond to activities in Slack",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "string"
+ },
+ "headers" : {
+ "type" : "object",
+ "properties" : {
+ "Content-Type" : {
+ "const" : "text/plain"
+ }
+ },
+ "required" : [ "Content-Type" ]
+ },
+ "status" : {
+ "const" : 200
+ }
+ },
+ "required" : [ "status", "headers", "body" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "challenge" : {
+ "type" : "string"
+ },
+ "type" : {
+ "const" : "url_verification"
+ }
+ },
+ "required" : [ "type", "challenge" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "event" : {
+ "type" : "object",
+ "properties" : {
+ "event_ts" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "event_ts" ]
+ },
+ "type" : {
+ "const" : "event_callback"
+ }
+ },
+ "required" : [ "type", "event" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type" ]
+ } ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/slack" ]
}
},
- "/api/field/{id}/search/{search-id}" : {
- "get" : {
- "operationId" : "get-api-field-id-search-search-id",
- "summary" : "GET /api/field/{id}/search/{search-id}",
- "description" : "Search for values of a Field with `search-id` that start with `value`. See docstring for\n [[metabase.parameters.field/search-values]] for a more detailed explanation.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "search-id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "query",
- "name" : "value",
- "required" : false,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
+ "/api/metabot/slack/interactive" : {
+ "post" : {
+ "operationId" : "post-api-metabot-slack-interactive",
+ "summary" : "POST /api/metabot/slack/interactive",
+ "description" : "Handle interactive payloads from Slack (button clicks, modal submissions).",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -38141,27 +37513,31 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/field" ]
+ "tags" : [ "/api/metabot/slack" ]
}
},
- "/api/field/{id}/summary" : {
- "get" : {
- "operationId" : "get-api-field-id-summary",
- "summary" : "GET /api/field/{id}/summary",
- "description" : "Get the count and distinct count of `Field` with ID.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "/api/metabot/slack/settings" : {
+ "put" : {
+ "operationId" : "put-api-metabot-slack-settings",
+ "summary" : "PUT /api/metabot/slack/settings",
+ "description" : "Update Metabot Slack settings atomically.\n All credential fields must be provided together.\n Setting values requires the metabot-v3 feature, but clearing values is always allowed.\n slack-connect-enabled is automatically set to true when credentials are provided, nil when cleared.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "ok" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "ok" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38170,27 +37546,84 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/field" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "metabot-slack-signing-secret" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "slack-connect-client-id" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "slack-connect-client-secret" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "slack-connect-client-id", "slack-connect-client-secret", "metabot-slack-signing-secret" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/slack" ]
}
},
- "/api/field/{id}/values" : {
- "get" : {
- "operationId" : "get-api-field-id-values",
- "summary" : "GET /api/field/{id}/values",
- "description" : "If a Field's value of `has_field_values` is `:list`, return a list of all the distinct values of the Field (or\n remapped Field), and (if defined by a User) a map of human-readable remapped values. If `has_field_values` is not\n `:list`, checks whether we should create FieldValues for this Field; if so, creates and returns them.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "/api/metabot/tools/answer-sources" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-answer-sources",
+ "summary" : "POST /api/metabot/tools/answer-sources",
+ "description" : "Return top level meta information about available information sources.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38199,25 +37632,86 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/field" ]
- },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.answer-sources-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/tools" ]
+ }
+ },
+ "/api/metabot/tools/create-alert" : {
"post" : {
- "operationId" : "post-api-field-id-values",
- "summary" : "POST /api/field/{id}/values",
- "description" : "Update the fields values and human-readable values for a `Field` whose semantic type is\n `category`/`city`/`state`/`country` or whose base type is `type/Boolean`. The human-readable values are optional.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "operationId" : "post-api-metabot-tools-create-alert",
+ "summary" : "POST /api/metabot/tools/create-alert",
+ "description" : "Create an alert for a saved question.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "error" : {
+ "type" : "string"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38230,49 +37724,82 @@
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "values" : {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "type" : "array",
- "prefixItems" : [ { } ]
- }, {
- "type" : "array",
- "prefixItems" : [ { }, {
- "type" : "string",
- "minLength" : 1
- } ]
- } ]
- }
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.create-alert-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "values" ]
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/field" ]
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/geojson" : {
- "get" : {
- "operationId" : "get-api-geojson",
- "summary" : "GET /api/geojson",
- "description" : "Load a custom GeoJSON file based on a URL or file path provided as a query parameter.\n This behaves similarly to /api/geojson/:key but doesn't require the custom map to be saved to the DB first.",
- "parameters" : [ {
- "in" : "query",
- "name" : "url",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
+ "/api/metabot/tools/create-dashboard-subscription" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-create-dashboard-subscription",
+ "summary" : "POST /api/metabot/tools/create-dashboard-subscription",
+ "description" : "Create a dashboard subscription and send it to a slack channel.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "error" : {
+ "type" : "string"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38281,26 +37808,83 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/geojson" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.create-dashboard-subscription-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/geojson/{key}" : {
- "get" : {
- "operationId" : "get-api-geojson-key",
- "summary" : "GET /api/geojson/{key}",
- "description" : "Fetch a custom GeoJSON file as defined in the [[metabase.geojson.settings/custom-geojson]] setting. (This just acts\n as a simple proxy for the file specified for `key`).",
- "parameters" : [ {
- "in" : "path",
- "name" : "key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
+ "/api/metabot/tools/field-values" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-field-values",
+ "summary" : "POST /api/metabot/tools/field-values",
+ "description" : "Return statistics and/or values for a given field of a given entity.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38309,36 +37893,83 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/geojson" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.field-values-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/glossary" : {
- "get" : {
- "operationId" : "get-api-glossary",
- "summary" : "GET /api/glossary",
- "description" : "Fetch all glossary entries, optionally filtered by search term.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/glossary" ]
- },
+ "/api/metabot/tools/filter-records" : {
"post" : {
- "operationId" : "post-api-glossary",
- "summary" : "POST /api/glossary",
- "description" : "Create a new glossary entry.",
+ "operationId" : "post-api-metabot-tools-filter-records",
+ "summary" : "POST /api/metabot/tools/filter-records",
+ "description" : "Apply filters to records from a data source (query, report, or table).",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38351,43 +37982,88 @@
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "definition" : {
- "type" : "string",
- "minLength" : 1
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.filter-records-arguments"
},
- "term" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
"type" : "string",
- "minLength" : 1
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "term", "definition" ]
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/glossary" ]
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/glossary/{id}" : {
- "put" : {
- "operationId" : "put-api-glossary-id",
- "summary" : "PUT /api/glossary/{id}",
- "description" : "Update an existing glossary entry.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "/api/metabot/tools/generate-insights" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-generate-insights",
+ "summary" : "POST /api/metabot/tools/generate-insights",
+ "description" : "Generate insights.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "output" : {
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "reactions" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabot.reaction.redirect"
+ }
+ }
+ },
+ "required" : [ "output", "reactions", "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38400,41 +38076,79 @@
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "definition" : {
- "type" : "string",
- "minLength" : 1
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.generate-insights-arguments"
},
- "term" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
"type" : "string",
- "minLength" : 1
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "term", "definition" ]
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/glossary" ]
- },
- "delete" : {
- "operationId" : "delete-api-glossary-id",
- "summary" : "DELETE /api/glossary/{id}",
- "description" : "Delete a glossary entry.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "tags" : [ "/api/metabot/tools" ]
+ }
+ },
+ "/api/metabot/tools/get-current-user" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-get-current-user",
+ "summary" : "POST /api/metabot/tools/get-current-user",
+ "description" : "Get information about user that started the conversation.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38443,18 +38157,57 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/glossary" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.deftool.tool-request"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/google/settings" : {
- "put" : {
- "operationId" : "put-api-google-settings",
- "summary" : "PUT /api/google/settings",
- "description" : "Update Google Sign-In related settings. You must be a superuser to do this.",
+ "/api/metabot/tools/get-dashboard-details" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-get-dashboard-details",
+ "summary" : "POST /api/metabot/tools/get-dashboard-details",
+ "description" : "Get information about a given dashboard.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38467,46 +38220,79 @@
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "google-auth-auto-create-accounts-domain" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.get-dashboard-details-arguments"
},
- "google-auth-client-id" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "google-auth-enabled" : {
+ "profile_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
}
- }
+ },
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/google" ]
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/ldap/settings" : {
- "put" : {
- "operationId" : "put-api-ldap-settings",
- "summary" : "PUT /api/ldap/settings",
- "description" : "Update LDAP related settings. You must be a superuser to do this.",
+ "/api/metabot/tools/get-document-details" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-get-document-details",
+ "summary" : "POST /api/metabot/tools/get-document-details",
+ "description" : "Get information about a given document.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38519,147 +38305,161 @@
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "ldap-enabled" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.get-document-details-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "ldap-host" : {
+ "profile_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/tools" ]
+ }
+ },
+ "/api/metabot/tools/get-metric-details" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-get-metric-details",
+ "summary" : "POST /api/metabot/tools/get-metric-details",
+ "description" : "Get information about a given metric.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "ldap-password" : {
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.get-metric-details-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "ldap-port" : {
+ "profile_id" : {
"oneOf" : [ {
- "type" : "integer",
- "minimum" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
}
- }
+ },
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/ldap" ]
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/llm/extract-tables" : {
+ "/api/metabot/tools/get-query-details" : {
"post" : {
- "operationId" : "post-api-llm-extract-tables",
- "summary" : "POST /api/llm/extract-tables",
- "description" : "Parse SQL and return referenced tables with their columns.\n\n Uses Macaw to parse the SQL, resolves table names to IDs,\n and returns permission-filtered tables with column metadata.\n\n This is a lightweight endpoint that does not trigger fingerprinting\n or field value fetching.",
+ "operationId" : "post-api-metabot-tools-get-query-details",
+ "summary" : "POST /api/metabot/tools/get-query-details",
+ "description" : "Get information about a given query.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "tables" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "columns" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "database_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "fk_target" : {
- "type" : "object",
- "properties" : {
- "field_name" : {
- "type" : "string"
- },
- "table_name" : {
- "type" : "string"
- }
- },
- "required" : [ "table_name", "field_name" ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string"
- },
- "semantic_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "name" ]
- }
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string"
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "name", "columns" ]
- }
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "tables" ]
+ "required" : [ "conversation_id" ]
}
}
}
@@ -38675,132 +38475,76 @@
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "database_id" : {
- "type" : "integer",
- "minimum" : 1
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.get-query-details-arguments"
},
- "sql" : {
- "type" : "string"
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "database_id", "sql" ]
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/llm" ]
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/llm/generate-sql" : {
+ "/api/metabot/tools/get-report-details" : {
"post" : {
- "operationId" : "post-api-llm-generate-sql",
- "summary" : "POST /api/llm/generate-sql",
- "description" : "Generate SQL from a natural language prompt.\n\n Requires:\n - LLM to be configured (Anthropic API key set in admin settings)\n - At least one table reference (explicit @mention or implicit from source_sql)\n - A database_id parameter\n\n Returns generated SQL and the list of tables used for context.",
+ "operationId" : "post-api-metabot-tools-get-report-details",
+ "summary" : "POST /api/metabot/tools/get-report-details",
+ "description" : "Get information about a given report.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "referenced_entities" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "columns" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "database_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "fk_target" : {
- "type" : "object",
- "properties" : {
- "field_name" : {
- "type" : "string"
- },
- "table_name" : {
- "type" : "string"
- }
- },
- "required" : [ "table_name", "field_name" ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "name" : {
- "type" : "string"
- },
- "semantic_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "name" ]
- }
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "model" : {
- "type" : "string"
- },
- "name" : {
- "type" : "string"
- },
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "model", "id", "name", "columns" ]
- }
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "sql" : {
- "type" : "string"
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "sql", "referenced_entities" ]
+ "required" : [ "conversation_id" ]
}
}
}
@@ -38816,74 +38560,79 @@
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "database_id" : {
- "type" : "integer",
- "minimum" : 1
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.get-report-details-arguments"
},
- "prompt" : {
- "type" : "string"
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "referenced_entities" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "integer",
- "minimum" : 1
- },
- "model" : {
- "type" : "string"
- }
- },
- "required" : [ "model", "id" ]
- }
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "source_sql" : {
- "type" : "string"
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "prompt", "database_id" ]
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/llm" ]
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/llm/list-models" : {
- "get" : {
- "operationId" : "get-api-llm-list-models",
- "summary" : "GET /api/llm/list-models",
- "description" : "List available LLM models from the configured provider.\n\n Requires LLM to be configured (Anthropic API key set in admin settings).",
+ "/api/metabot/tools/get-snippet-details" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-get-snippet-details",
+ "summary" : "POST /api/metabot/tools/get-snippet-details",
+ "description" : "Get the content of a single SQL snippet.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "models" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "display_name" : {
- "type" : "string"
- },
- "id" : {
- "type" : "string"
- }
- },
- "required" : [ "id", "display_name" ]
- }
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "structured_output" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.full-snippet"
}
},
- "required" : [ "models" ]
+ "required" : [ "structured_output", "conversation_id" ]
}
}
}
@@ -38895,75 +38644,89 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/llm" ]
- }
- },
- "/api/logger/adjustment" : {
- "post" : {
- "operationId" : "post-api-logger-adjustment",
- "summary" : "POST /api/logger/adjustment",
- "description" : "Temporarily adjust the log levels.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "duration" : {
- "type" : "integer"
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.get-snippet-details-arguments"
},
- "duration_unit" : {
- "$ref" : "#/components/schemas/metabase.logger.api.time-unit"
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "log_levels" : { }
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "required" : [ "duration", "duration_unit", "log_levels" ]
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/logger" ]
- },
- "delete" : {
- "operationId" : "delete-api-logger-adjustment",
- "summary" : "DELETE /api/logger/adjustment",
- "description" : "Undo any log level adjustments.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/logger" ]
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/logger/logs" : {
- "get" : {
- "operationId" : "get-api-logger-logs",
- "summary" : "GET /api/logger/logs",
- "description" : "Logs.",
+ "/api/metabot/tools/get-snippets" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-get-snippets",
+ "summary" : "POST /api/metabot/tools/get-snippets",
+ "description" : "Get a list of all known SQL snippets.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "structured_output" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.basic-snippet"
+ }
+ }
+ },
+ "required" : [ "structured_output", "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -38972,49 +38735,54 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/logger" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.deftool.tool-request"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/logger/presets" : {
- "get" : {
- "operationId" : "get-api-logger-presets",
- "summary" : "GET /api/logger/presets",
- "description" : "Get all known presets.",
+ "/api/metabot/tools/get-table-details" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-get-table-details",
+ "summary" : "POST /api/metabot/tools/get-table-details",
+ "description" : "Get information about a given table or model.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"content" : {
"application/json" : {
"schema" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "display_name" : {
- "type" : "string"
- },
- "id" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
"type" : "string"
- },
- "loggers" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "level" : {
- "$ref" : "#/components/schemas/metabase.logger.api.log-level"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "name", "level" ]
- }
- }
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "id", "display_name", "loggers" ]
- }
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
}
}
}
@@ -39026,18 +38794,83 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/logger" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.get-table-details-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/login-history/current" : {
- "get" : {
- "operationId" : "get-api-login-history-current",
- "summary" : "GET /api/login-history/current",
- "description" : "Fetch recent logins for the current user.",
+ "/api/metabot/tools/get-tables" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-get-tables",
+ "summary" : "POST /api/metabot/tools/get-tables",
+ "description" : "Get information about the tables in a given database.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -39046,22 +38879,80 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/login-history" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.get-tables-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/measure" : {
+ "/api/metabot/tools/query-datasource" : {
"post" : {
- "operationId" : "post-api-measure",
- "summary" : "POST /api/measure",
- "description" : "Create a new `Measure`.",
+ "operationId" : "post-api-metabot-tools-query-datasource",
+ "summary" : "POST /api/metabot/tools/query-datasource",
+ "description" : "Construct a query from a model or table data source.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
}
}
}
@@ -39077,52 +38968,76 @@
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "definition" : {
- "description" : "Value must be a map.",
- "type" : "object",
- "properties" : { }
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.query-datasource-arguments"
},
- "description" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string",
- "minLength" : 1
- },
- "table_id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "name", "table_id", "definition" ]
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/measure" ]
- },
- "get" : {
- "operationId" : "get-api-measure",
- "summary" : "GET /api/measure",
- "description" : "Fetch *all* `Measures`.",
+ "tags" : [ "/api/metabot/tools" ]
+ }
+ },
+ "/api/metabot/tools/query-metric" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-query-metric",
+ "summary" : "POST /api/metabot/tools/query-metric",
+ "description" : "Construct a query from a metric.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"content" : {
"application/json" : {
"schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/metabase.measures.api.measure"
- }
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
}
}
}
@@ -39134,65 +39049,80 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/measure" ]
- }
- },
- "/api/measure/{id}" : {
- "get" : {
- "operationId" : "get-api-measure-id",
- "summary" : "GET /api/measure/{id}",
- "description" : "Fetch `Measure` with ID.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.measures.api.measure"
- }
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.query-metric-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ]
}
}
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
}
},
- "tags" : [ "/api/measure" ]
- },
- "put" : {
- "operationId" : "put-api-measure-id",
- "summary" : "PUT /api/measure/{id}",
- "description" : "Update a `Measure` with ID.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
+ "tags" : [ "/api/metabot/tools" ]
+ }
+ },
+ "/api/metabot/tools/query-model" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-query-model",
+ "summary" : "POST /api/metabot/tools/query-model",
+ "description" : "Construct a query from a model.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
}
}
}
@@ -39208,89 +39138,76 @@
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.query-model-arguments"
},
- "definition" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "description" : {
+ "metabot_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "name" : {
+ "profile_id" : {
"oneOf" : [ {
- "type" : "string",
- "minLength" : 1
+ "type" : "string"
}, {
"type" : "null"
} ]
- },
- "revision_message" : {
- "type" : "string",
- "minLength" : 1
}
},
- "required" : [ "revision_message" ]
+ "required" : [ "arguments", "conversation_id" ]
}
}
}
},
- "tags" : [ "/api/measure" ]
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/measure/{id}/dimension/{dimension-key}/remapping" : {
- "get" : {
- "operationId" : "get-api-measure-id-dimension-dimension-key-remapping",
- "summary" : "GET /api/measure/{id}/dimension/{dimension-key}/remapping",
- "description" : "Fetch remapped value for a specific dimension value.\n\n Returns a pair [value, display-name] if remapping exists, or [value] otherwise.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "dimension-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "description" : "value must be a valid UUID."
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
+ "/api/metabot/tools/search" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-search",
+ "summary" : "POST /api/metabot/tools/search",
+ "description" : "Enhanced search with term and semantic queries using Reciprocal Rank Fusion.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.measures.api.RemappedValueResponse"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
}
}
}
@@ -39302,119 +39219,80 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/measure" ]
- }
- },
- "/api/measure/{id}/dimension/{dimension-key}/search" : {
- "get" : {
- "operationId" : "get-api-measure-id-dimension-dimension-key-search",
- "summary" : "GET /api/measure/{id}/dimension/{dimension-key}/search",
- "description" : "Search for values of a dimension that contain the query string.\n\n Returns field values matching the search query in the same format as the field values API.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "dimension-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "description" : "value must be a valid UUID."
- }, {
- "in" : "query",
- "name" : "query",
- "required" : true,
- "schema" : {
- "type" : "string",
- "minLength" : 1
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "array",
- "items" : {
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.search-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
"type" : "string"
- }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
- }
+ },
+ "required" : [ "conversation_id" ]
}
}
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
}
},
- "tags" : [ "/api/measure" ]
+ "tags" : [ "/api/metabot/tools" ]
}
},
- "/api/measure/{id}/dimension/{dimension-key}/values" : {
- "get" : {
- "operationId" : "get-api-measure-id-dimension-dimension-key-values",
- "summary" : "GET /api/measure/{id}/dimension/{dimension-key}/values",
- "description" : "Fetch values for a dimension of a measure.\n\n Returns field values in the same format as the field values API:\n - values: list of [value] or [value, display-name] tuples\n - field_id: the underlying field ID\n - has_more_values: boolean indicating if there are more values",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- }, {
- "in" : "path",
- "name" : "dimension-key",
- "required" : true,
- "schema" : {
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
- "description" : "value must be a valid UUID."
- } ],
+ "/api/metabot/tools/search_v2" : {
+ "post" : {
+ "operationId" : "post-api-metabot-tools-search_v2",
+ "summary" : "POST /api/metabot/tools/search_v2",
+ "description" : "Enhanced search with term and semantic queries using Reciprocal Rank Fusion. This is identical to /search, but\n duplicated in order to add a new capability to AI service that indicates that Metabot can search transforms. The\n /search endpoint is kept around for backward compatibility.",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"type" : "object",
"properties" : {
- "has_more_values" : {
- "type" : "boolean"
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
- "values" : {
- "type" : "array",
- "items" : {
- "anyOf" : [ {
- "type" : "array",
- "prefixItems" : [ { }, {
- "type" : "string"
- } ]
- }, {
- "type" : "array",
- "prefixItems" : [ { } ]
- } ]
- }
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "has_more_values", "values" ]
+ "required" : [ "conversation_id" ]
}
}
}
@@ -39426,7 +39304,42 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/measure" ]
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "type" : "object",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase.metabot.tools.api.search-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "metabot_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metabot/tools" ]
}
},
"/api/metric" : {
@@ -49710,6 +49623,19 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "user-id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 1cd73824c54..d0838de1004 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -1207,8 +1207,6 @@ The map tile server URL template used in map visualizations, for example from Op
### `MB_METABOT_SLACK_SIGNING_SECRET`
-> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
-
- Type: string
- Default: `null`
- [Configuration file name](./config-file.md): `metabot-slack-signing-secret`
@@ -1899,8 +1897,6 @@ The name of the channel where bug reports should be posted.
### `MB_SLACK_CONNECT_ATTRIBUTE_TEAM_ID`
-> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
-
- Type: string
- Default: `https://slack.com/team_id`
- [Configuration file name](./config-file.md): `slack-connect-attribute-team-id`
@@ -1909,8 +1905,6 @@ Slack OIDC claim for the team/workspace ID.
### `MB_SLACK_CONNECT_AUTHENTICATION_MODE`
-> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
-
- Type: string
- Default: `link-only`
- [Configuration file name](./config-file.md): `slack-connect-authentication-mode`
@@ -1919,8 +1913,6 @@ Controls whether Slack can be used for SSO login or just account linking. Valid
### `MB_SLACK_CONNECT_CLIENT_ID`
-> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
-
- Type: string
- Default: `null`
- [Configuration file name](./config-file.md): `slack-connect-client-id`
@@ -1929,8 +1921,6 @@ Client ID for your Slack app. Get this from https://api.slack.com/apps.
### `MB_SLACK_CONNECT_CLIENT_SECRET`
-> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
-
- Type: string
- Default: `null`
- [Configuration file name](./config-file.md): `slack-connect-client-secret`
@@ -1939,8 +1929,6 @@ Client Secret for your Slack app.
### `MB_SLACK_CONNECT_ENABLED`
-> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
-
- Type: boolean
- Default: `false`
- [Configuration file name](./config-file.md): `slack-connect-enabled`
@@ -1949,8 +1937,6 @@ Is Slack Connect authentication configured and enabled?
### `MB_SLACK_CONNECT_USER_PROVISIONING_ENABLED`
-> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
-
- Type: boolean
- Default: `true`
- [Configuration file name](./config-file.md): `slack-connect-user-provisioning-enabled`