Skip to content

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

fix self-heal openapi job and update openapi.json (#70499)

Jakub Chodorowicz5fe95dbbae75
diff --git a/.github/actions/prepare-frontend/action.yml b/.github/actions/prepare-frontend/action.yml
index ce0fbbaec3d..1d74cfe70d7 100644
--- a/.github/actions/prepare-frontend/action.yml
+++ b/.github/actions/prepare-frontend/action.yml
@@ -11,17 +11,10 @@ inputs:
runs:
using: "composite"
steps:
- - name: Prepare Node.js
- uses: actions/setup-node@v4
+ - name: Prepare Node + Bun environment
+ uses: ./.github/actions/prepare-node-bun
with:
- node-version: ${{ inputs.node-version }} # this overrides, if present
- node-version-file: ".nvmrc"
-
- - name: Install bun
- uses: oven-sh/setup-bun@v2
- with:
- bun-version: "1.3.7"
- token: ${{ github.token }}
+ node-version: ${{ inputs.node-version }}
- name: Get cache keys
uses: ./.github/actions/get-cache-keys
diff --git a/.github/actions/prepare-node-bun/action.yml b/.github/actions/prepare-node-bun/action.yml
new file mode 100644
index 00000000000..d1cc92a0d58
--- /dev/null
+++ b/.github/actions/prepare-node-bun/action.yml
@@ -0,0 +1,20 @@
+name: Prepare Node + Bun environment
+description: "Set up Node.js and Bun for CI jobs"
+inputs:
+ node-version:
+ description: "The version of Node.js to use, overriding .nvmrc"
+ required: false
+runs:
+ using: "composite"
+ steps:
+ - name: Prepare Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: ${{ inputs.node-version }}
+ node-version-file: ".nvmrc"
+
+ - name: Install bun
+ uses: oven-sh/setup-bun@v2
+ with:
+ bun-version: "1.3.7"
+ token: ${{ github.token }}
diff --git a/.github/workflows/openapi-check.yml b/.github/workflows/openapi-check.yml
index b09df15a7bd..2d8c816abb5 100644
--- a/.github/workflows/openapi-check.yml
+++ b/.github/workflows/openapi-check.yml
@@ -22,10 +22,8 @@ jobs:
token: ${{ secrets.METABASE_AUTOMATION_USER_TOKEN }}
# fetch full git history to allow fetching the latest base branch commit and comparing changes
fetch-depth: 0
- - name: Setup Node.js 22
- uses: actions/setup-node@v4
- with:
- node-version: 22.x
+ - name: Prepare Node + Bun environment
+ uses: ./.github/actions/prepare-node-bun
- name: Prepare back-end environment
uses: ./.github/actions/prepare-backend
- name: Generate version.properties
diff --git a/resources/openapi/openapi.json b/resources/openapi/openapi.json
index 9ecb1cb730b..98620ba86fb 100644
--- a/resources/openapi/openapi.json
+++ b/resources/openapi/openapi.json
@@ -100,15 +100,6 @@
} ]
} ]
},
- "mbql.clause.!=" : { },
- "mbql.clause.*" : { },
- "mbql.clause.+" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-temporal-interval-schema"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-numeric-schema"
- } ]
- },
"mbql.clause.-" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-temporal-interval-schema"
@@ -122,10 +113,11 @@
} ]
} ]
},
- "mbql.clause./" : { },
- "mbql.clause.<" : {
+ "mbql.clause._BANG__EQ_" : { },
+ "mbql.clause._EQ_" : { },
+ "mbql.clause._GT_" : {
"prefixItems" : [ {
- "const" : "<"
+ "const" : ">"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
@@ -135,9 +127,9 @@
} ],
"type" : "array"
},
- "mbql.clause.<=" : {
+ "mbql.clause._GT__EQ_" : {
"prefixItems" : [ {
- "const" : "<="
+ "const" : ">="
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
@@ -147,10 +139,9 @@
} ],
"type" : "array"
},
- "mbql.clause.=" : { },
- "mbql.clause.>" : {
+ "mbql.clause._LT_" : {
"prefixItems" : [ {
- "const" : ">"
+ "const" : "<"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
@@ -160,9 +151,9 @@
} ],
"type" : "array"
},
- "mbql.clause.>=" : {
+ "mbql.clause._LT__EQ_" : {
"prefixItems" : [ {
- "const" : ">="
+ "const" : "<="
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.common.options"
}, {
@@ -172,6 +163,15 @@
} ],
"type" : "array"
},
+ "mbql.clause._PLUS_" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-temporal-interval-schema"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.arithmetic.plus-minus-numeric-schema"
+ } ]
+ },
+ "mbql.clause._SLASH_" : { },
+ "mbql.clause._STAR_" : { },
"mbql.clause.abs" : {
"prefixItems" : [ {
"const" : "abs"
@@ -1142,457 +1142,827 @@
} ],
"description" : "All the various ways of referring to an action with the v2 APIs."
},
- "metabase-enterprise.data-studio.api.table.bulk-table-info" : {
- "description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
+ "metabase-enterprise.agent-api.api.column-metadata" : {
+ "description" : "Metadata for a single result column.",
"properties" : {
- "db_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "display_name" : {
+ "base_type" : {
"type" : "string"
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "is_published" : {
- "type" : "boolean"
- },
- "name" : {
+ "display_name" : {
"type" : "string"
},
- "schema" : {
+ "effective_type" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "name" : {
+ "type" : "string"
}
},
- "required" : [ "id", "db_id", "name", "display_name", "schema", "is_published" ],
+ "required" : [ "name", "base_type", "display_name" ],
"type" : "object"
},
- "metabase-enterprise.data-studio.api.table.bulk-table-selection-info" : {
- "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
- "properties" : {
- "published_downstream_tables" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"
+ "metabase-enterprise.agent-api.api.construct-query-metric-request" : {
+ "allOf" : [ {
+ "properties" : {
+ "filters" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : "array"
- },
- "selected_table" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"
- }, {
- "type" : "null"
- } ]
- },
- "unpublished_upstream_tables" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-info"
+ "group_by" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.group-by"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : "array"
- }
- },
- "required" : [ "selected_table", "published_downstream_tables", "unpublished_upstream_tables" ],
- "type" : "object"
- },
- "metabase-enterprise.data-studio.api.table.data-authorities" : {
- "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ],
- "type" : "string"
- },
- "metabase-enterprise.data-studio.api.table.data-layers" : {
- "enum" : [ "copper", "bronze", "gold", "silver" ],
- "type" : "string"
+ "metric_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "metric_id" ],
+ "type" : "object"
+ }, {
+ "properties" : { },
+ "type" : "object"
+ } ],
+ "description" : "Request schema for constructing a query from a metric.\n Only supports filters and group_by (aggregation is defined by the metric)."
},
- "metabase-enterprise.data-studio.api.table.data-sources" : {
- "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ],
- "type" : "string"
+ "metabase-enterprise.agent-api.api.construct-query-request" : {
+ "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"
+ } ],
+ "description" : "Request schema for /v1/construct-query. Accepts either table_id or metric_id."
},
- "metabase-enterprise.data-studio.api.table.publish-tables-response" : {
- "description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",
+ "metabase-enterprise.agent-api.api.construct-query-response" : {
+ "description" : "Response containing a base64-encoded MBQL query for use with /v1/execute.",
"properties" : {
- "target_collection" : {
- "oneOf" : [ {
- "description" : "value must be an instance of :model/Collection"
- }, {
- "type" : "null"
- } ]
+ "query" : {
+ "minLength" : 1,
+ "type" : "string"
}
},
- "required" : [ "target_collection" ],
+ "required" : [ "query" ],
"type" : "object"
},
- "metabase-enterprise.data-studio.api.table.table-selectors" : {
- "properties" : {
- "database_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "metabase-enterprise.agent-api.api.construct-query-table-request" : {
+ "allOf" : [ {
+ "properties" : {
+ "aggregations" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.aggregation"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : "array"
- },
- "schema_ids" : {
- "items" : {
- "type" : "string"
+ "fields" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : "array"
- },
- "table_ids" : {
- "items" : {
+ "filters" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "group_by" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.group-by"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "limit" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "order_by" : {
+ "description" : "Order by regular fields only. To order by aggregation results, use sort_order on the aggregation.",
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.order-by"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
"type" : "integer"
- },
- "type" : "array"
+ }
+ },
+ "required" : [ "table_id" ],
+ "type" : "object"
+ }, {
+ "properties" : { },
+ "type" : "object"
+ } ],
+ "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"
+ },
+ "metabase-enterprise.agent-api.api.entity-type" : {
+ "description" : "The type of queryable entity.",
+ "enum" : [ "table", "metric" ],
+ "type" : "string"
+ },
+ "metabase-enterprise.agent-api.api.execute-query-request" : {
+ "description" : "Request schema for /v1/execute. Accepts a base64-encoded MBQL query.",
+ "properties" : {
+ "query" : {
+ "minLength" : 1,
+ "type" : "string"
}
},
+ "required" : [ "query" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.base-entity" : {
+ "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.",
"properties" : {
"data" : {
- "properties" : { },
+ "properties" : {
+ "cols" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.column-metadata"
+ },
+ "type" : "array"
+ },
+ "rows" : {
+ "items" : {
+ "items" : { },
+ "type" : "array"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "cols", "rows" ],
"type" : "object"
},
- "dependents_count" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
- }, {
- "type" : "null"
- } ]
+ "error" : {
+ "type" : "string"
},
- "errors" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
- },
- "type" : "array",
- "uniqueItems" : true
+ "row_count" : {
+ "type" : "integer"
},
- "id" : {
- "minimum" : 1,
+ "running_time" : {
"type" : "integer"
},
- "type" : {
+ "status" : {
+ "enum" : [ "completed", "failed" ],
"type" : "string"
}
},
- "required" : [ "id", "type", "data", "dependents_count" ],
- "type" : "object"
- },
- "metabase-enterprise.dependencies.api.broken-cards-response" : {
- "properties" : {
- "bad_cards" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.queries.schema.card"
- },
- "type" : "array"
- },
- "bad_transforms" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform"
- },
- "type" : "array"
- },
- "success" : {
- "type" : "boolean"
- }
- },
- "required" : [ "success" ],
+ "required" : [ "status" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.card-body" : {
- "description" : "Schema for an instance of a `:model/Card` (everything is optional to support updates).",
+ "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.",
"properties" : {
- "collection_id" : {
+ "database_type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "dashboard_id" : {
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "database_id" : {
+ "field_id" : {
+ "type" : "string"
+ },
+ "field_values" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ "items" : { },
+ "type" : "array"
}, {
"type" : "null"
} ]
},
- "dataset_query" : {
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field-type"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "field_id", "name" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.agent-api.api.field-type" : {
+ "description" : "A data type for a field derived from Metabase's type hierarchy.",
+ "enum" : [ "boolean", "date", "datetime", "time", "number", "string" ],
+ "type" : "string"
+ },
+ "metabase-enterprise.agent-api.api.field-values" : {
+ "description" : "Statistics and sample values for a specific field.",
+ "properties" : {
+ "field_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "document_id" : {
+ "statistics" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.statistics"
}, {
"type" : "null"
} ]
},
- "id" : {
+ "values" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ "items" : { },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ },
+ "metabase-enterprise.agent-api.api.measure" : {
+ "description" : "A reusable aggregation expression associated with a table. Reference via measure_id in the aggregations array.",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
},
+ "id" : {
+ "type" : "integer"
+ },
"name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ],
+ "type" : "object"
+ },
+ "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.",
+ "properties" : {
+ "default_time_dimension_field_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "parameter_mappings" : {
+ "description" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "parameters" : {
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "queryable_dimensions" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
},
- "result_metadata" : {
+ "segments" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.segment"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
},
"type" : {
+ "const" : "metric"
+ },
+ "verified" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
},
+ "required" : [ "id", "type", "name" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.card-entity" : {
+ "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.",
"properties" : {
- "data" : {
- "properties" : {
- "collection" : { },
- "collection_id" : { },
- "created_at" : { },
- "creator" : { },
- "creator_id" : { },
- "dashboard" : { },
- "dashboard_id" : { },
- "database_id" : { },
- "description" : { },
- "display" : { },
- "document" : { },
- "document_id" : { },
- "last-edit-info" : { },
- "name" : { },
- "query_type" : { },
- "result_metadata" : { },
- "type" : { },
- "view_count" : { }
- },
- "type" : "object"
- },
- "dependents_count" : {
+ "default_time_dimension_field_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "errors" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
- },
- "type" : "array",
- "uniqueItems" : true
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"id" : {
- "minimum" : 1,
"type" : "integer"
},
+ "name" : {
+ "type" : "string"
+ },
"type" : {
- "const" : "card"
+ "const" : "metric"
}
},
- "required" : [ "id", "type", "data", "dependents_count" ],
+ "required" : [ "id", "type", "name" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.dashboard-entity" : {
+ "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.",
"properties" : {
- "data" : {
- "properties" : {
- "collection" : { },
- "collection_id" : { },
- "created_at" : { },
- "creator" : { },
- "creator_id" : { },
- "description" : { },
- "last-edit-info" : { },
- "moderation_reviews" : { },
- "name" : { },
- "view_count" : { }
- },
- "type" : "object"
+ "database_engine" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "dependents_count" : {
+ "database_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "errors" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
- },
- "type" : "array",
- "uniqueItems" : true
+ "database_schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fields" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
},
"id" : {
- "minimum" : 1,
"type" : "integer"
},
+ "name" : {
+ "type" : "string"
+ },
+ "related_by" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"type" : {
- "const" : "dashboard"
+ "const" : "table"
}
},
- "required" : [ "id", "type", "data", "dependents_count" ],
+ "required" : [ "id", "type", "name" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.document-entity" : {
+ "metabase-enterprise.agent-api.api.search-response" : {
+ "description" : "Search results containing tables and metrics matching the query.",
"properties" : {
"data" : {
- "properties" : {
- "collection" : { },
- "collection_id" : { },
- "created_at" : { },
- "creator" : { },
- "description" : { },
- "name" : { },
- "view_count" : { }
- },
- "type" : "object"
- },
- "dependents_count" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
- }, {
- "type" : "null"
- } ]
- },
- "errors" : {
"items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.search-result-item"
},
- "type" : "array",
- "uniqueItems" : true
+ "type" : "array"
},
- "id" : {
- "minimum" : 1,
+ "total_count" : {
"type" : "integer"
- },
- "type" : {
- "const" : "document"
}
},
- "required" : [ "id", "type", "data", "dependents_count" ],
+ "required" : [ "data", "total_count" ],
"type" : "object"
},
- "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.agent-api.api.search-result-item" : {
+ "description" : "A table or metric returned from search.",
+ "properties" : {
+ "created_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "database_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "enum" : [ "table", "metric" ],
+ "type" : "string"
+ },
+ "updated_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "verified" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "type", "name" ],
+ "type" : "object"
},
- "metabase-enterprise.dependencies.api.graph-response" : {
+ "metabase-enterprise.agent-api.api.segment" : {
+ "description" : "A predefined filter condition that can be applied to queries via the segment_id in filters.",
"properties" : {
- "edges" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ],
+ "type" : "object"
+ },
+ "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.",
+ "properties" : {
+ "average_length" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "avg" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "distinct_count" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "earliest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "latest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "max" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "min" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "percent_email" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "percent_json" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "percent_null" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "percent_state" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "percent_url" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "q1" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "q3" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "sd" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ },
+ "metabase-enterprise.agent-api.api.table" : {
+ "description" : "Full details of a table including its fields, related tables, metrics, and segments.",
+ "properties" : {
+ "database_engine" : {
+ "type" : "string"
+ },
+ "database_id" : {
+ "type" : "integer"
+ },
+ "database_schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "fields" : {
"items" : {
- "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"
- }
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field"
+ },
+ "type" : "array"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "measures" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.measure"
},
- "required" : [ "from_entity_type", "from_entity_id", "to_entity_type", "to_entity_id" ],
- "type" : "object"
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metrics" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.metric-summary"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "related_tables" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.related-table"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "segments" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.segment"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.entity-type"
+ }
+ },
+ "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.data-studio.api.table.publish-tables-response" : {
+ "description" : "Schema for /publish-tables endpoint response. Matches frontend PublishTablesResponse type.",
+ "properties" : {
+ "target_collection" : {
+ "oneOf" : [ {
+ "description" : "value must be an instance of :model/Collection"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "target_collection" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.data-studio.api.table.table-selectors" : {
+ "properties" : {
+ "database_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
},
"type" : "array"
},
- "nodes" : {
+ "schema_ids" : {
"items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "table_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
},
"type" : "array"
}
},
- "required" : [ "nodes", "edges" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.measure-entity" : {
+ "metabase-enterprise.dependencies.api.base-entity" : {
"properties" : {
"data" : {
- "properties" : {
- "created_at" : { },
- "creator" : { },
- "creator_id" : { },
- "description" : { },
- "name" : { },
- "table" : { },
- "table_id" : { }
- },
+ "properties" : { },
"type" : "object"
},
"dependents_count" : {
@@ -1602,9 +1972,9 @@
"type" : "null"
} ]
},
- "errors" : {
+ "dependents_errors" : {
"items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
},
"type" : "array",
"uniqueItems" : true
@@ -1614,47 +1984,142 @@
"type" : "integer"
},
"type" : {
- "const" : "measure"
+ "type" : "string"
}
},
"required" : [ "id", "type", "data", "dependents_count" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.sandbox-entity" : {
+ "metabase-enterprise.dependencies.api.broken-cards-response" : {
"properties" : {
- "data" : {
- "properties" : {
- "table" : { },
- "table_id" : { }
+ "bad_cards" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.card"
+ },
+ "type" : "array"
+ },
+ "bad_transforms" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform"
},
+ "type" : "array"
+ },
+ "success" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "success" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.dependencies.api.broken-dependent-entity" : {
+ "description" : "Entity returned by /graph/broken endpoint - includes errors but no dependents_count.",
+ "properties" : {
+ "data" : {
+ "properties" : { },
"type" : "object"
},
- "dependents_count" : {
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "type", "data" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.dependencies.api.card-body" : {
+ "description" : "Schema for an instance of a `:model/Card` (everything is optional to support updates).",
+ "properties" : {
+ "collection_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
}, {
"type" : "null"
} ]
},
- "errors" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
- },
- "type" : "array",
- "uniqueItems" : true
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "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"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "document_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
+ }, {
+ "type" : "null"
+ } ]
},
"id" : {
- "minimum" : 1,
- "type" : "integer"
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "result_metadata" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
+ }, {
+ "type" : "null"
+ } ]
},
"type" : {
- "const" : "sandbox"
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "id", "type", "data", "dependents_count" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.segment-entity" : {
+ "metabase-enterprise.dependencies.api.card-entity" : {
"properties" : {
"data" : {
"properties" : {
@@ -1686,9 +2151,9 @@
"type" : "null"
} ]
},
- "errors" : {
+ "dependents_errors" : {
"items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
},
"type" : "array",
"uniqueItems" : true
@@ -1698,13 +2163,13 @@
"type" : "integer"
},
"type" : {
- "const" : "segment"
+ "const" : "card"
}
},
"required" : [ "id", "type", "data", "dependents_count" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.snippet-entity" : {
+ "metabase-enterprise.dependencies.api.dashboard-entity" : {
"properties" : {
"data" : {
"properties" : {
@@ -1714,7 +2179,10 @@
"creator" : { },
"creator_id" : { },
"description" : { },
- "name" : { }
+ "last-edit-info" : { },
+ "moderation_reviews" : { },
+ "name" : { },
+ "view_count" : { }
},
"type" : "object"
},
@@ -1725,9 +2193,9 @@
"type" : "null"
} ]
},
- "errors" : {
+ "dependents_errors" : {
"items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
},
"type" : "array",
"uniqueItems" : true
@@ -1737,23 +2205,23 @@
"type" : "integer"
},
"type" : {
- "const" : "snippet"
+ "const" : "dashboard"
}
},
"required" : [ "id", "type", "data", "dependents_count" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.table-entity" : {
+ "metabase-enterprise.dependencies.api.document-entity" : {
"properties" : {
"data" : {
"properties" : {
- "db" : { },
- "db_id" : { },
+ "collection" : { },
+ "collection_id" : { },
+ "created_at" : { },
+ "creator" : { },
"description" : { },
- "display_name" : { },
- "fields" : { },
"name" : { },
- "schema" : { }
+ "view_count" : { }
},
"type" : "object"
},
@@ -1764,9 +2232,9 @@
"type" : "null"
} ]
},
- "errors" : {
+ "dependents_errors" : {
"items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
},
"type" : "array",
"uniqueItems" : true
@@ -1776,28 +2244,287 @@
"type" : "integer"
},
"type" : {
- "const" : "table"
+ "const" : "document"
}
},
"required" : [ "id", "type", "data", "dependents_count" ],
"type" : "object"
},
- "metabase-enterprise.dependencies.api.transform-body" : {
- "properties" : {
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
- },
- "name" : {
- "type" : "string"
- },
- "source" : {
- "oneOf" : [ {
- "properties" : {
- "query" : {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
- },
- "type" : {
- "type" : "string"
+ "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" : {
+ "properties" : {
+ "edges" : {
+ "items" : {
+ "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" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "nodes" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "nodes", "edges" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.dependencies.api.measure-entity" : {
+ "properties" : {
+ "data" : {
+ "properties" : {
+ "created_at" : { },
+ "creator" : { },
+ "creator_id" : { },
+ "description" : { },
+ "name" : { },
+ "table" : { },
+ "table_id" : { }
+ },
+ "type" : "object"
+ },
+ "dependents_count" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dependents_errors" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : {
+ "const" : "measure"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.dependencies.api.sandbox-entity" : {
+ "properties" : {
+ "data" : {
+ "properties" : {
+ "table" : { },
+ "table_id" : { }
+ },
+ "type" : "object"
+ },
+ "dependents_count" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dependents_errors" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : {
+ "const" : "sandbox"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.dependencies.api.segment-entity" : {
+ "properties" : {
+ "data" : {
+ "properties" : {
+ "collection" : { },
+ "collection_id" : { },
+ "created_at" : { },
+ "creator" : { },
+ "creator_id" : { },
+ "dashboard" : { },
+ "dashboard_id" : { },
+ "database_id" : { },
+ "description" : { },
+ "display" : { },
+ "document" : { },
+ "document_id" : { },
+ "last-edit-info" : { },
+ "name" : { },
+ "query_type" : { },
+ "result_metadata" : { },
+ "type" : { },
+ "view_count" : { }
+ },
+ "type" : "object"
+ },
+ "dependents_count" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dependents_errors" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : {
+ "const" : "segment"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.dependencies.api.snippet-entity" : {
+ "properties" : {
+ "data" : {
+ "properties" : {
+ "collection" : { },
+ "collection_id" : { },
+ "created_at" : { },
+ "creator" : { },
+ "creator_id" : { },
+ "description" : { },
+ "name" : { }
+ },
+ "type" : "object"
+ },
+ "dependents_count" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dependents_errors" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : {
+ "const" : "snippet"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.dependencies.api.table-entity" : {
+ "properties" : {
+ "data" : {
+ "properties" : {
+ "db" : { },
+ "db_id" : { },
+ "description" : { },
+ "display_name" : { },
+ "fields" : { },
+ "name" : { },
+ "owner" : { },
+ "owner_email" : { },
+ "owner_user_id" : { },
+ "schema" : { },
+ "transform" : { }
+ },
+ "type" : "object"
+ },
+ "dependents_count" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.usages"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dependents_errors" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : {
+ "const" : "table"
+ }
+ },
+ "required" : [ "id", "type", "data", "dependents_count" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.dependencies.api.transform-body" : {
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "source" : {
+ "oneOf" : [ {
+ "properties" : {
+ "query" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ },
+ "type" : {
+ "type" : "string"
}
},
"type" : "object"
@@ -1826,6 +2553,9 @@
"description" : { },
"last_run" : { },
"name" : { },
+ "owner" : { },
+ "owner_email" : { },
+ "owner_user_id" : { },
"table" : { }
},
"type" : "object"
@@ -1837,9 +2567,9 @@
"type" : "null"
} ]
},
- "errors" : {
+ "dependents_errors" : {
"items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.error"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error"
},
"type" : "array",
"uniqueItems" : true
@@ -1869,6 +2599,52 @@
"minimum" : 1,
"type" : "integer"
},
+ "metabase-enterprise.dependencies.models.analysis-finding-error.analysis-finding-error" : {
+ "description" : "Schema for an AnalysisFindingError record.",
+ "properties" : {
+ "analyzed_entity_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "analyzed_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ },
+ "error_detail" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "error_type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.validate.validate-error-type"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "source_entity_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_entity_type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.validate.source-entity-type"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "analyzed_entity_type", "analyzed_entity_id", "error_type" ],
+ "type" : "object"
+ },
"metabase-enterprise.metabot-v3.client.schema.message" : {
"properties" : {
"content" : {
@@ -1930,11 +2706,13 @@
},
"metabase-enterprise.metabot-v3.tools.api.aggregation" : {
"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"
} ],
- "description" : "Aggregation - either field-based or measure-based."
+ "description" : "Aggregation — count (field optional), field-based (field required), or measure-based."
},
"metabase-enterprise.metabot-v3.tools.api.answer-sources-arguments" : {
"allOf" : [ {
@@ -2217,6 +2995,32 @@
"metabase-enterprise.metabot-v3.tools.api.count" : {
"type" : "integer"
},
+ "metabase-enterprise.metabot-v3.tools.api.count-aggregation" : {
+ "allOf" : [ {
+ "properties" : {
+ "bucket" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.bucket"
+ },
+ "function" : {
+ "const" : "count"
+ },
+ "sort_order" : {
+ "oneOf" : [ {
+ "enum" : [ "asc", "desc" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "function" ],
+ "type" : "object"
+ }, {
+ "properties" : { },
+ "type" : "object"
+ } ],
+ "description" : "Count aggregation — counts rows, no field_id needed.\n Use sort_order to order results by this aggregation ('asc' or 'desc')."
+ },
"metabase-enterprise.metabot-v3.tools.api.create-dashboard-subscription-arguments" : {
"allOf" : [ {
"properties" : {
@@ -2244,7 +3048,7 @@
"type" : "string"
},
"operation" : {
- "enum" : [ "equals", "not-equals", "number-equals", "number-not-equals" ],
+ "enum" : [ "equals", "not-equals" ],
"type" : "string"
},
"values" : {
@@ -2389,7 +3193,7 @@
"type" : "string"
},
"function" : {
- "enum" : [ "avg", "count", "count-distinct", "max", "min", "sum" ],
+ "enum" : [ "avg", "count-distinct", "max", "min", "sum" ],
"type" : "string"
},
"sort_order" : {
@@ -2407,7 +3211,7 @@
"properties" : { },
"type" : "object"
} ],
- "description" : "Aggregation using a field and function."
+ "description" : "Aggregation using a field and function. field_id is required.\n Use sort_order to order results by this aggregation ('asc' or 'desc')."
},
"metabase-enterprise.metabot-v3.tools.api.field-type" : {
"enum" : [ "boolean", "date", "datetime", "time", "number", "string" ],
@@ -3559,7 +4363,7 @@
"type" : "string"
},
"operation" : {
- "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal", "number-equals", "number-not-equals", "number-greater-than", "number-greater-than-or-equal", "number-less-than", "number-less-than-or-equal" ],
+ "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ],
"type" : "string"
},
"value" : {
@@ -3577,6 +4381,20 @@
"type" : "object"
} ]
},
+ "metabase-enterprise.metabot-v3.tools.api.order-by" : {
+ "description" : "Order by item specifying a field and sort direction.",
+ "properties" : {
+ "direction" : {
+ "enum" : [ "asc", "desc" ],
+ "type" : "string"
+ },
+ "field" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"
+ }
+ },
+ "required" : [ "field", "direction" ],
+ "type" : "object"
+ },
"metabase-enterprise.metabot-v3.tools.api.proportion" : {
"type" : "number"
},
@@ -3636,17 +4454,7 @@
"order_by" : {
"oneOf" : [ {
"items" : {
- "properties" : {
- "direction" : {
- "enum" : [ "asc", "desc" ],
- "type" : "string"
- },
- "field" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"
- }
- },
- "required" : [ "field", "direction" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.order-by"
},
"type" : "array"
}, {
@@ -3753,17 +4561,7 @@
"order_by" : {
"oneOf" : [ {
"items" : {
- "properties" : {
- "direction" : {
- "enum" : [ "asc", "desc" ],
- "type" : "string"
- },
- "field" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field"
- }
- },
- "required" : [ "field", "direction" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.order-by"
},
"type" : "array"
}, {
@@ -4160,7 +4958,7 @@
"type" : "string"
},
"operation" : {
- "enum" : [ "equals", "not-equals", "string-equals", "string-not-equals", "string-contains", "string-not-contains", "string-starts-with", "string-ends-with" ],
+ "enum" : [ "equals", "not-equals", "string-contains", "string-not-contains", "string-starts-with", "string-ends-with" ],
"type" : "string"
},
"value" : {
@@ -4335,7 +5133,7 @@
"type" : "string"
},
"operation" : {
- "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal", "date-equals", "date-not-equals", "date-before", "date-on-or-before", "date-after", "date-on-or-after" ],
+ "enum" : [ "equals", "not-equals", "greater-than", "greater-than-or-equal", "less-than", "less-than-or-equal" ],
"type" : "string"
},
"value" : {
@@ -4373,10 +5171,10 @@
"type" : "object"
},
"metabase-enterprise.metabot-v3.tools.transforms.transform-source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.api.transform-source"
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
},
"metabase-enterprise.metabot-v3.tools.transforms.transform-target" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.api.transform-target"
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
},
"metabase-enterprise.permission-debug.impl.group-id" : {
"type" : "integer"
@@ -4587,50 +5385,74 @@
"metabase-enterprise.support-access-grants.schema.timestamp" : {
"anyOf" : [ { }, { } ]
},
- "metabase-enterprise.transforms.api.run-trigger" : {
- "enum" : [ "none", "global-schedule" ],
- "type" : "string"
- },
- "metabase-enterprise.transforms.api.transform-source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-source"
+ "metabase-enterprise.workspaces.api.appdb-or-ref-id" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ } ]
},
- "metabase-enterprise.transforms.api.transform-target" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-target"
+ "metabase-enterprise.workspaces.api.dependency-graph" : {
+ "additionalProperties" : {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "description" : "Map of shorthand symbols to lists of dependencies. The latter are all strings, and refs need to be detected.",
+ "type" : "object"
},
- "metabase-enterprise.transforms.schema.append-config" : {
+ "metabase-enterprise.workspaces.api.graph-edge" : {
"properties" : {
- "type" : {
- "const" : "append"
+ "from_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.appdb-or-ref-id"
+ },
+ "from_entity_type" : {
+ "type" : "string"
+ },
+ "to_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.appdb-or-ref-id"
+ },
+ "to_entity_type" : {
+ "type" : "string"
}
},
- "required" : [ "type" ],
+ "required" : [ "from_entity_id", "from_entity_type", "to_entity_id", "to_entity_type" ],
"type" : "object"
},
- "metabase-enterprise.transforms.schema.checkpoint-strategy" : {
+ "metabase-enterprise.workspaces.api.graph-node" : {
"properties" : {
- "checkpoint-filter" : {
- "type" : "string"
+ "data" : {
+ "properties" : { },
+ "type" : "object"
},
- "checkpoint-filter-unique-key" : {
- "$ref" : "#/components/schemas/metabase.lib.metadata.column.column-unique-key"
+ "dependents_count" : {
+ "additionalProperties" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "object"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.appdb-or-ref-id"
},
"type" : {
- "const" : "checkpoint"
+ "enum" : [ "input-table", "external-transform", "workspace-transform" ],
+ "type" : "string"
}
},
- "required" : [ "type" ],
+ "required" : [ "id", "type", "dependents_count", "data" ],
"type" : "object"
},
- "metabase-enterprise.transforms.schema.source-incremental-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.checkpoint-strategy"
- } ]
+ "metabase-enterprise.workspaces.api.graph-node-type" : {
+ "enum" : [ "input-table", "external-transform", "workspace-transform" ],
+ "type" : "string"
},
- "metabase-enterprise.transforms.schema.source-table-ref" : {
- "description" : "A reference to a source table by name, for cases where table_id may not exist yet.\n Also saves querying metadata in situations where we'll need the name.",
+ "metabase-enterprise.workspaces.api.input-table" : {
"properties" : {
- "database_id" : {
- "type" : "integer"
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
},
"schema" : {
"oneOf" : [ {
@@ -4644,108 +5466,145 @@
},
"table_id" : {
"oneOf" : [ {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "database_id", "table" ],
+ "required" : [ "db_id", "schema", "table", "table_id" ],
"type" : "object"
},
- "metabase-enterprise.transforms.schema.source-table-value" : {
- "anyOf" : [ {
- "type" : "integer"
- }, {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.source-table-ref"
- } ],
- "description" : "Either a table ID (int) or a reference map."
- },
- "metabase-enterprise.transforms.schema.table-incremental-target" : {
+ "metabase-enterprise.workspaces.api.output-table" : {
"properties" : {
- "database" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
- },
- "schema" : {
- "anyOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
},
- "target-incremental-strategy" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.target-incremental-strategy"
+ "global" : {
+ "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" ],
+ "type" : "object"
},
- "type" : {
- "const" : "table-incremental"
+ "isolated" : {
+ "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" ],
+ "type" : "object"
}
},
- "required" : [ "type", "name", "target-incremental-strategy" ],
+ "required" : [ "db_id", "global", "isolated" ],
"type" : "object"
},
- "metabase-enterprise.transforms.schema.table-target" : {
+ "metabase-enterprise.workspaces.api.status" : {
+ "enum" : [ "archived", "ready", "broken", "pending", "uninitialized" ],
+ "type" : "string"
+ },
+ "metabase-enterprise.workspaces.api.test-resources-request" : {
+ "description" : "Request body for creating test resources.",
"properties" : {
- "database" : {
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
},
- "schema" : {
- "anyOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "global" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.dependency-graph"
},
- "type" : {
- "const" : "table"
+ "workspace" : {
+ "properties" : {
+ "checkouts" : {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "definitions" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.dependency-graph"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
}
},
- "required" : [ "type", "name" ],
"type" : "object"
},
- "metabase-enterprise.transforms.schema.target-incremental-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.append-config"
- } ]
- },
- "metabase-enterprise.transforms.schema.transform" : {
+ "metabase-enterprise.workspaces.api.test-resources-response" : {
+ "description" : "Response from creating test resources.",
"properties" : {
- "description" : {
+ "global-map" : {
+ "additionalProperties" : {
+ "type" : "integer"
+ },
+ "type" : "object"
+ },
+ "workspace-id" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string"
- },
- "source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-source"
- },
- "target" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-target"
+ "workspace-map" : {
+ "additionalProperties" : {
+ "type" : "string"
+ },
+ "type" : "object"
}
},
- "required" : [ "name", "source", "target" ],
+ "required" : [ "workspace-id", "global-map", "workspace-map" ],
"type" : "object"
},
- "metabase-enterprise.transforms.schema.transform-source" : {
+ "metabase-enterprise.workspaces.api.transform-source" : {
"oneOf" : [ {
"properties" : {
"query" : {
"$ref" : "#/components/schemas/metabase.queries.schema.query"
},
- "source-incremental-strategy" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.source-incremental-strategy"
- },
"type" : {
"const" : "query"
}
@@ -4753,6 +5612,7 @@
"required" : [ "type", "query" ],
"type" : "object"
}, {
+ "additionalProperties" : false,
"properties" : {
"body" : {
"type" : "string"
@@ -4760,14 +5620,21 @@
"source-database" : {
"type" : "integer"
},
- "source-incremental-strategy" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.source-incremental-strategy"
- },
"source-tables" : {
- "additionalProperties" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.source-table-value"
+ "items" : {
+ "properties" : {
+ "alias" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "table_id" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "alias", "table_id" ],
+ "type" : "object"
},
- "type" : "object"
+ "type" : "array"
},
"type" : {
"const" : "python"
@@ -4777,12 +5644,215 @@
"type" : "object"
} ]
},
- "metabase-enterprise.transforms.schema.transform-target" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.table-target"
+ "metabase-enterprise.workspaces.api.transform-target" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "database" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "enum" : [ "table" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "name" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.workspaces.types.ancestors-result" : {
+ "description" : "Result of running stale ancestor transforms.",
+ "properties" : {
+ "failed" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "type" : "array"
+ },
+ "not_run" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "type" : "array"
+ },
+ "succeeded" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "succeeded", "failed", "not_run" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.workspaces.types.appdb-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "metabase-enterprise.workspaces.types.execution-result" : {
+ "properties" : {
+ "ancestors" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ancestors-result"
+ },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "start_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "enum" : [ "succeeded", "failed" ],
+ "type" : "string"
+ },
+ "table" : {
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name" ],
+ "type" : "object"
+ }
+ },
+ "required" : [ "status", "table" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.workspaces.types.flag" : {
+ "anyOf" : [ {
+ "const" : 1
}, {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.table-incremental-target"
- } ]
+ "type" : "boolean"
+ } ],
+ "description" : "Boolean flag that accepts true, false, or 1 (for query param compatibility)."
+ },
+ "metabase-enterprise.workspaces.types.problem" : {
+ "description" : "A problem detected during workspace validation.",
+ "properties" : {
+ "block_merge" : {
+ "type" : "boolean"
+ },
+ "category" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.problem-category"
+ },
+ "data" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "problem" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.problem-name"
+ },
+ "severity" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.severity"
+ }
+ },
+ "required" : [ "category", "problem", "severity", "block_merge", "data" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.workspaces.types.problem-category" : {
+ "enum" : [ "external", "external-downstream", "unused", "internal", "internal-downstream" ],
+ "type" : "string"
+ },
+ "metabase-enterprise.workspaces.types.problem-name" : {
+ "enum" : [ "target-conflict", "not-run", "stale", "cycle", "failed", "removed-table", "removed-field" ],
+ "type" : "string"
+ },
+ "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.",
+ "properties" : {
+ "ancestors" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ancestors-result"
+ },
+ "data" : {
+ "properties" : {
+ "cols" : {
+ "items" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "results_metadata" : {
+ "properties" : {
+ "columns" : {
+ "items" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "rows" : {
+ "items" : { },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "running_time" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "started_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "status" : {
+ "enum" : [ "succeeded", "failed" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "status" ],
+ "type" : "object"
+ },
+ "metabase-enterprise.workspaces.types.ref-id" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "metabase-enterprise.workspaces.types.severity" : {
+ "enum" : [ "error", "warning", "info" ],
+ "type" : "string"
},
"metabase.actions.schema..action.for-insert" : {
"allOf" : [ {
@@ -5426,6 +6496,38 @@
"type" : "object"
} ]
},
+ "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.",
+ "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" ],
+ "type" : "object"
+ },
+ "metabase.channel.models.channel.ChannelTemplateUserProvided" : {
+ "description" : "Channel Template schema for API-provided templates. Does not allow handlebars-resource.",
+ "oneOf" : [ {
+ "properties" : {
+ "channel_type" : { },
+ "details" : {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateEmailDetailsUserProvided"
+ }
+ },
+ "required" : [ "channel_type", "details" ],
+ "type" : "object"
+ }, { } ]
+ },
"metabase.collections-rest.api.DashboardQuestionCandidate" : {
"properties" : {
"description" : {
@@ -5833,22 +6935,122 @@
"required" : [ "id", "email", "first_name", "last_name", "timestamp" ],
"type" : "object"
},
+ "metabase.data-studio.api.table.bulk-table-info" : {
+ "description" : "Schema for table info in bulk operations. Matches frontend BulkTableInfo type.",
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_published" : {
+ "type" : "boolean"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "db_id", "name", "display_name", "schema", "is_published" ],
+ "type" : "object"
+ },
+ "metabase.data-studio.api.table.bulk-table-selection-info" : {
+ "description" : "Schema for /selection endpoint response. Matches frontend BulkTableSelectionInfo type.",
+ "properties" : {
+ "published_downstream_tables" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ },
+ "type" : "array"
+ },
+ "selected_table" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "unpublished_upstream_tables" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-info"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "selected_table", "published_downstream_tables", "unpublished_upstream_tables" ],
+ "type" : "object"
+ },
+ "metabase.data-studio.api.table.data-authorities" : {
+ "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ],
+ "type" : "string"
+ },
+ "metabase.data-studio.api.table.data-layers" : {
+ "enum" : [ "final", "internal", "hidden" ],
+ "type" : "string"
+ },
+ "metabase.data-studio.api.table.data-sources" : {
+ "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ],
+ "type" : "string"
+ },
+ "metabase.data-studio.api.table.table-selectors" : {
+ "properties" : {
+ "database_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "schema_ids" : {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "table_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ },
"metabase.documents.schema..document.id" : {
"description" : "Valid Document ID",
"minimum" : 1,
"type" : "integer"
},
- "metabase.legacy-mbql.schema.!=" : {
- "allOf" : [ ],
- "description" : "schema for a valid MBQL 4 :!= clause"
- },
- "metabase.legacy-mbql.schema.*" : {
- "allOf" : [ ],
- "description" : "schema for a valid MBQL 4 :* clause"
+ "metabase.documents.schema.document" : {
+ "description" : "Schema for an instance of a `:model/Document`.",
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
+ }
+ },
+ "required" : [ "id" ],
+ "type" : "object"
},
- "metabase.legacy-mbql.schema.+" : {
- "allOf" : [ ],
- "description" : "schema for a valid MBQL 4 :+ clause"
+ "metabase.driver.connection.connection-type" : {
+ "enum" : [ "default", "write-data" ],
+ "type" : "string"
},
"metabase.legacy-mbql.schema.-" : {
"allOf" : [ ],
@@ -6012,6 +7214,28 @@
"required" : [ "type", "name", "display-name", "card-id" ],
"type" : "object"
},
+ "metabase.legacy-mbql.schema..TemplateTag.SourceTable" : {
+ "description" : "Things required by all template tag types.",
+ "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"
+ },
+ "table-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "type" : {
+ "const" : "table"
+ }
+ },
+ "required" : [ "type", "name", "display-name", "table-id" ],
+ "type" : "object"
+ },
"metabase.legacy-mbql.schema..TemplateTag.TemporalUnit" : {
"description" : "Things required by all template tag types.",
"properties" : {
@@ -6084,6 +7308,54 @@
},
"metabase.legacy-mbql.schema..legacy-column-metadata.qualified-keys" : {
"properties" : {
+ "lib/binning" : {
+ "oneOf" : [ {
+ "allOf" : [ {
+ "properties" : {
+ "strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
+ }
+ },
+ "required" : [ "strategy" ],
+ "type" : "object"
+ }, {
+ "oneOf" : [ {
+ "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" : "object"
+ } ]
+ } ],
+ "description" : "Schema for `:binning` options passed to a `:field` clause."
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
@@ -6131,6 +7403,13 @@
"type" : "null"
} ]
},
+ "lib/from-model?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
@@ -6138,8 +7417,9 @@
"type" : "null"
} ]
},
- "lib/model-display-name" : {
+ "lib/join-alias" : {
"oneOf" : [ {
+ "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
@@ -6200,6 +7480,13 @@
"type" : "null"
} ]
},
+ "lib/original-effective-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/original-expression-name" : {
"oneOf" : [ {
"minLength" : 1,
@@ -6238,6 +7525,14 @@
"type" : "null"
} ]
},
+ "lib/simple-display-name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
@@ -6260,70 +7555,42 @@
"type" : "null"
} ]
},
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "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" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/type" : {
"const" : "metadata/column",
"default" : "metadata/column"
},
- "metabase.lib.field/binning" : {
+ "metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
- "allOf" : [ {
- "properties" : {
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.strategy"
- }
- },
- "required" : [ "strategy" ],
- "type" : "object"
- }, {
- "oneOf" : [ {
- "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" : "object"
- } ]
- } ],
- "description" : "Schema for `:binning` options passed to a `:field` clause."
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
- "metabase.lib.field/temporal-unit" : {
+ "metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
- "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" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
}, {
"type" : "null"
} ]
},
- "metabase.lib.join/join-alias" : {
+ "qp.pivot/pivot-grouping?" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -6338,30 +7605,6 @@
},
"type" : "object"
},
- "metabase.legacy-mbql.schema./" : {
- "allOf" : [ ],
- "description" : "schema for a valid MBQL 4 :/ clause"
- },
- "metabase.legacy-mbql.schema.<" : {
- "allOf" : [ ],
- "description" : "schema for a valid MBQL 4 :< clause"
- },
- "metabase.legacy-mbql.schema.<=" : {
- "allOf" : [ ],
- "description" : "schema for a valid MBQL 4 :<= clause"
- },
- "metabase.legacy-mbql.schema.=" : {
- "allOf" : [ ],
- "description" : "schema for a valid MBQL 4 := clause"
- },
- "metabase.legacy-mbql.schema.>" : {
- "allOf" : [ ],
- "description" : "schema for a valid MBQL 4 :> clause"
- },
- "metabase.legacy-mbql.schema.>=" : {
- "allOf" : [ ],
- "description" : "schema for a valid MBQL 4 :>= clause"
- },
"metabase.legacy-mbql.schema.Addable" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.NumericExpressionArg"
@@ -6446,17 +7689,17 @@
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.not"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.="
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._EQ_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.!="
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._BANG__EQ_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.<"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.>"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.<="
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._LT__EQ_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.>="
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._GT__EQ_"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.between"
}, {
@@ -6578,7 +7821,7 @@
"metabase.legacy-mbql.schema.DatetimeExpression" : {
"description" : "Schema for the definition of a date function expression.",
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.+"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._PLUS_"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.datetime-add"
}, {
@@ -6788,87 +8031,98 @@
"metabase.legacy-mbql.schema.FieldRefOptions" : {
"description" : "Options for an MBQL 4 `:field` ref are the same as MBQL 5, except that `:lib/uuid` is not required and it cannot be\n empty.",
"oneOf" : [ {
- "default" : { },
- "properties" : {
- "base-type" : {
- "oneOf" : [ {
+ "allOf" : [ {
+ "default" : { },
+ "properties" : {
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "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"
+ } ]
+ },
+ "inherited-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ },
+ "lib/original-binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "lib/original-effective-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "database-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "oneOf" : [ {
+ },
+ "lib/uuid" : {
+ "maxLength" : 36,
+ "minLength" : 36,
+ "type" : "string"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "original-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "qp.pivot/pivot-grouping?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-field" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "source-field-join-alias" : {
"$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"
- } ]
- },
- "inherited-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "lib/original-binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "lib/uuid" : {
- "maxLength" : 36,
- "minLength" : 36,
- "type" : "string"
- },
- "metabase.lib.field/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "metabase.lib.field/original-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "name" : {
- "oneOf" : [ {
+ },
+ "source-field-name" : {
"$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"
- } ]
- },
- "source-field" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "source-field-join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "source-field-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }
},
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }
- },
- "type" : "object"
+ "type" : "object"
+ }, {
+ "allOf" : [ ]
+ } ]
}, {
"type" : "null"
} ]
@@ -7083,13 +8337,13 @@
"metabase.legacy-mbql.schema.NumericExpression" : {
"description" : "Schema for the definition of a numeric expression. All numeric expressions evaluate to numeric values.",
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.+"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._PLUS_"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.-"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.~1"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._SLASH_"
}, {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.*"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema._STAR_"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.coalesce"
}, {
@@ -7387,6 +8641,8 @@
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.Snippet"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.SourceQuery"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.SourceTable"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema..TemplateTag.TemporalUnit"
}, {
@@ -7406,7 +8662,7 @@
},
"metabase.legacy-mbql.schema.TemplateTagType" : {
"description" : "Schema for valid values of template tag `:type`.",
- "enum" : [ "snippet", "card", "dimension", "number", "text", "date" ],
+ "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "table" ],
"type" : "string"
},
"metabase.legacy-mbql.schema.TemporalExtractUnit" : {
@@ -7491,6 +8747,42 @@
"$ref" : "#/components/schemas/metabase.lib.schema.parameter.widget-type",
"description" : "Schema for valid values of `:widget-type` for a `::TemplateTag.FieldFilter`."
},
+ "metabase.legacy-mbql.schema._BANG__EQ_" : {
+ "allOf" : [ ],
+ "description" : "schema for a valid MBQL 4 :!= clause"
+ },
+ "metabase.legacy-mbql.schema._EQ_" : {
+ "allOf" : [ ],
+ "description" : "schema for a valid MBQL 4 := clause"
+ },
+ "metabase.legacy-mbql.schema._GT_" : {
+ "allOf" : [ ],
+ "description" : "schema for a valid MBQL 4 :> clause"
+ },
+ "metabase.legacy-mbql.schema._GT__EQ_" : {
+ "allOf" : [ ],
+ "description" : "schema for a valid MBQL 4 :>= clause"
+ },
+ "metabase.legacy-mbql.schema._LT_" : {
+ "allOf" : [ ],
+ "description" : "schema for a valid MBQL 4 :< clause"
+ },
+ "metabase.legacy-mbql.schema._LT__EQ_" : {
+ "allOf" : [ ],
+ "description" : "schema for a valid MBQL 4 :<= clause"
+ },
+ "metabase.legacy-mbql.schema._PLUS_" : {
+ "allOf" : [ ],
+ "description" : "schema for a valid MBQL 4 :+ clause"
+ },
+ "metabase.legacy-mbql.schema._SLASH_" : {
+ "allOf" : [ ],
+ "description" : "schema for a valid MBQL 4 :/ clause"
+ },
+ "metabase.legacy-mbql.schema._STAR_" : {
+ "allOf" : [ ],
+ "description" : "schema for a valid MBQL 4 :* clause"
+ },
"metabase.legacy-mbql.schema.abs" : {
"allOf" : [ ],
"description" : "schema for a valid MBQL 4 :abs clause"
@@ -7771,68 +9063,7 @@
"type" : "null"
} ]
},
- "lib/breakout?" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "lib/card-id" : {
- "oneOf" : [ {
- "description" : "Valid Card ID",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "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/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"
- } ]
- },
- "lib/expression-name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/external-remap" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
- }, {
- "type" : "null"
- } ]
- },
- "lib/internal-remap" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
- }, {
- "type" : "null"
- } ]
- },
- "lib/model-display-name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "lib/original-binning" : {
+ "lib/binning" : {
"oneOf" : [ {
"allOf" : [ {
"properties" : {
@@ -7880,78 +9111,76 @@
"type" : "null"
} ]
},
- "lib/original-display-name" : {
+ "lib/breakout?" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "lib/original-expression-name" : {
+ "lib/card-id" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
+ "description" : "Valid Card ID",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "lib/original-join-alias" : {
+ "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" : [ {
- "minLength" : 1,
"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.",
+ "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"
} ]
},
- "lib/ref-display-name" : {
+ "lib/expression-name" : {
"oneOf" : [ {
+ "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/ref-name" : {
+ "lib/external-remap" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
}, {
"type" : "null"
} ]
},
- "lib/source" : {
+ "lib/from-model?" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "lib/source-column-alias" : {
+ "lib/internal-remap" : {
"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"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
}, {
"type" : "null"
} ]
},
- "lib/source-uuid" : {
+ "lib/join-alias" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ "minLength" : 1,
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "lib/type" : {
- "const" : "metadata/column",
- "default" : "metadata/column"
- },
- "metabase.lib.field/binning" : {
+ "lib/original-binning" : {
"oneOf" : [ {
"allOf" : [ {
"properties" : {
@@ -7999,15 +9228,59 @@
"type" : "null"
} ]
},
- "metabase.lib.field/temporal-unit" : {
+ "lib/original-display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-effective-type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-expression-name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/original-join-alias" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "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/ref-display-name" : {
"oneOf" : [ {
- "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" : "string"
}, {
"type" : "null"
} ]
},
- "metabase.lib.join/join-alias" : {
+ "lib/ref-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/simple-display-name" : {
"oneOf" : [ {
"minLength" : 1,
"type" : "string"
@@ -8015,9 +9288,71 @@
"type" : "null"
} ]
},
+ "lib/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
+ }, {
+ "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/source-uuid" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "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" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/transformation-added-base-type" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lib/type" : {
+ "const" : "metadata/column",
+ "default" : "metadata/column"
+ },
+ "metabase.lib.metadata.result-metadata/field-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metabase.lib.metadata.result-metadata/source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
+ }, {
+ "type" : "null"
+ } ]
+ },
"name" : {
"type" : "string"
},
+ "qp.pivot/pivot-grouping?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"qp/implicit-field?" : {
"oneOf" : [ {
"type" : "boolean"
@@ -8215,10 +9550,6 @@
"allOf" : [ ],
"description" : "schema for a valid MBQL 4 :value clause"
},
- "metabase.lib.metadata.column.column-unique-key" : {
- "pattern" : "^column-unique-key-v\\d+\\$.+$",
- "type" : "string"
- },
"metabase.lib.metadata.protocols.metadata-provider" : {
"description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
},
@@ -8442,6 +9773,10 @@
"$ref" : "#/components/schemas/metabase.lib.schema.util.distinct-mbql-clauses"
} ]
},
+ "metabase.lib.schema.column-unique-key" : {
+ "pattern" : "^column-unique-key-v\\d+\\$.+$",
+ "type" : "string"
+ },
"metabase.lib.schema.common.base-type" : {
"type" : "string"
},
@@ -8531,6 +9866,7 @@
},
"type" : "object"
},
+ "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"
},
@@ -8715,6 +10051,8 @@
"type" : "array"
}, {
"$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" : {
@@ -8828,7 +10166,7 @@
},
"metabase.lib.schema.info.context" : {
"description" : "Schema for `info.context`; used for informational purposes to record how a query was executed.",
- "enum" : [ "action", "ad-hoc", "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" ],
+ "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" ],
"type" : "string"
},
"metabase.lib.schema.info.hash" : {
@@ -8880,6 +10218,21 @@
"type" : "null"
} ]
},
+ "lens-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "lens-params" : {
+ "oneOf" : [ {
+ "additionalProperties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
"metadata/model-metadata" : {
"oneOf" : [ {
"items" : {
@@ -8925,6 +10278,13 @@
}, {
"type" : "null"
} ]
+ },
+ "transform-id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.transform"
+ }, {
+ "type" : "null"
+ } ]
}
},
"type" : "object"
@@ -9001,7 +10361,7 @@
},
"metabase.lib.schema.join.strategy" : {
"default" : "left-join",
- "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, `:left-join` is the default 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.",
"enum" : [ "left-join", "right-join", "inner-join", "full-join" ],
"type" : "string"
},
@@ -9153,25 +10513,25 @@
},
"metabase.lib.schema.mbql-clause.clause" : {
"oneOf" : [ { }, {
- "$ref" : "#/components/schemas/mbql.clause.!="
+ "$ref" : "#/components/schemas/mbql.clause._BANG__EQ_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.*"
+ "$ref" : "#/components/schemas/mbql.clause._STAR_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.+"
+ "$ref" : "#/components/schemas/mbql.clause._PLUS_"
}, {
"$ref" : "#/components/schemas/mbql.clause.-"
}, {
- "$ref" : "#/components/schemas/mbql.clause.~1"
+ "$ref" : "#/components/schemas/mbql.clause._SLASH_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.<"
+ "$ref" : "#/components/schemas/mbql.clause._LT_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.<="
+ "$ref" : "#/components/schemas/mbql.clause._LT__EQ_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.="
+ "$ref" : "#/components/schemas/mbql.clause._EQ_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.>"
+ "$ref" : "#/components/schemas/mbql.clause._GT_"
}, {
- "$ref" : "#/components/schemas/mbql.clause.>="
+ "$ref" : "#/components/schemas/mbql.clause._GT__EQ_"
}, {
"$ref" : "#/components/schemas/mbql.clause.abs"
}, {
@@ -9513,13 +10873,6 @@
"type" : "null"
} ]
},
- "field-ref" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
- }, {
- "type" : "null"
- } ]
- },
"fingerprint" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
@@ -9576,6 +10929,13 @@
"type" : "null"
} ]
},
+ "lib/binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
@@ -9614,6 +10974,13 @@
"type" : "null"
} ]
},
+ "lib/from-model?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
@@ -9621,9 +10988,9 @@
"type" : "null"
} ]
},
- "lib/model-display-name" : {
+ "lib/join-alias" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
@@ -9642,6 +11009,13 @@
"type" : "null"
} ]
},
+ "lib/original-effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/original-expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -9673,6 +11047,13 @@
"type" : "null"
} ]
},
+ "lib/simple-display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
@@ -9694,27 +11075,34 @@
"type" : "null"
} ]
},
- "lib/type" : {
- "const" : "metadata/column",
- "default" : "metadata/column"
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.lib.field/binning" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "metabase.lib.field/temporal-unit" : {
+ "lib/type" : {
+ "const" : "metadata/column",
+ "default" : "metadata/column"
+ },
+ "metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
- "metabase.lib.join/join-alias" : {
+ "metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
}, {
"type" : "null"
} ]
@@ -9732,6 +11120,13 @@
"type" : "null"
} ]
},
+ "qp.pivot/pivot-grouping?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"qp/implicit-field?" : {
"oneOf" : [ {
"type" : "boolean"
@@ -9757,20 +11152,6 @@
"type" : "null"
} ]
},
- "source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
- }, {
- "type" : "null"
- } ]
- },
- "source-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
"visibility-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
@@ -9785,6 +11166,8 @@
"$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
+ }, {
+ "allOf" : [ ]
} ],
"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."
},
@@ -10001,13 +11384,6 @@
"type" : "null"
} ]
},
- "field-ref" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
- }, {
- "type" : "null"
- } ]
- },
"fingerprint" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.fingerprint.fingerprint"
@@ -10064,6 +11440,13 @@
"type" : "null"
} ]
},
+ "lib/binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/breakout?" : {
"oneOf" : [ {
"type" : "boolean"
@@ -10102,6 +11485,13 @@
"type" : "null"
} ]
},
+ "lib/from-model?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/internal-remap" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.internal"
@@ -10109,9 +11499,9 @@
"type" : "null"
} ]
},
- "lib/model-display-name" : {
+ "lib/join-alias" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
}, {
"type" : "null"
} ]
@@ -10130,6 +11520,13 @@
"type" : "null"
} ]
},
+ "lib/original-effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/original-expression-name" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -10161,6 +11558,13 @@
"type" : "null"
} ]
},
+ "lib/simple-display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"lib/source" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.source"
@@ -10182,27 +11586,34 @@
"type" : "null"
} ]
},
- "lib/type" : {
- "const" : "metadata/column",
- "default" : "metadata/column"
+ "lib/temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
},
- "metabase.lib.field/binning" : {
+ "lib/transformation-added-base-type" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "metabase.lib.field/temporal-unit" : {
+ "lib/type" : {
+ "const" : "metadata/column",
+ "default" : "metadata/column"
+ },
+ "metabase.lib.metadata.result-metadata/field-ref" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.Reference"
}, {
"type" : "null"
} ]
},
- "metabase.lib.join/join-alias" : {
+ "metabase.lib.metadata.result-metadata/source" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
}, {
"type" : "null"
} ]
@@ -10220,6 +11631,13 @@
"type" : "null"
} ]
},
+ "qp.pivot/pivot-grouping?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"qp/implicit-field?" : {
"oneOf" : [ {
"type" : "boolean"
@@ -10245,20 +11663,6 @@
"type" : "null"
} ]
},
- "source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.legacy-source"
- }, {
- "type" : "null"
- } ]
- },
- "source-alias" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
"visibility-type" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
@@ -10273,6 +11677,8 @@
"$ref" : "#/components/schemas/metabase.lib.schema.common.kebab-cased-map"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
+ }, {
+ "allOf" : [ ]
} ],
"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."
}, {
@@ -10358,6 +11764,10 @@
},
"type" : "object"
},
+ "metabase.lib.schema.order-by.direction" : {
+ "enum" : [ "asc", "desc" ],
+ "type" : "string"
+ },
"metabase.lib.schema.order-by.order-by" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/mbql.clause.asc"
@@ -10652,164 +12062,186 @@
"type" : "array"
},
"metabase.lib.schema.ref..field.literal.options" : {
- "default" : { },
- "properties" : {
- "base-type" : {
- "type" : "string"
- },
- "binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "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" : [ {
+ "allOf" : [ {
+ "default" : { },
+ "properties" : {
+ "base-type" : {
+ "type" : "string"
+ },
+ "binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "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"
+ } ]
+ },
+ "inherited-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ },
+ "lib/original-binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "lib/original-effective-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "inherited-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "lib/original-binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- },
- "metabase.lib.field/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "metabase.lib.field/original-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "name" : {
- "oneOf" : [ {
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "original-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "qp.pivot/pivot-grouping?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-field" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "source-field-join-alias" : {
"$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"
- } ]
- },
- "source-field" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "source-field-join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "source-field-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "source-field-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }
},
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }
- },
- "required" : [ "lib/uuid", "base-type" ],
- "type" : "object"
+ "required" : [ "lib/uuid", "base-type" ],
+ "type" : "object"
+ }, {
+ "allOf" : [ ]
+ } ]
},
"metabase.lib.schema.ref..field.options" : {
- "default" : { },
- "properties" : {
- "base-type" : {
- "oneOf" : [ {
+ "allOf" : [ {
+ "default" : { },
+ "properties" : {
+ "base-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "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"
+ } ]
+ },
+ "inherited-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "join-alias" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
+ },
+ "lib/original-binning" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
+ },
+ "lib/original-effective-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- }, {
- "type" : "null"
- } ]
- },
- "binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "database-type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- }, {
- "type" : "null"
- } ]
- },
- "display-name" : {
- "oneOf" : [ {
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "original-temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "qp.pivot/pivot-grouping?" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source-field" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "source-field-join-alias" : {
"$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"
- } ]
- },
- "inherited-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
- },
- "lib/original-binning" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.binning.binning"
- },
- "lib/uuid" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
- },
- "metabase.lib.field/original-effective-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
- },
- "metabase.lib.field/original-temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "name" : {
- "oneOf" : [ {
+ },
+ "source-field-name" : {
"$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"
- } ]
- },
- "source-field" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "source-field-join-alias" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "source-field-name" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "temporal-unit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }
},
- "temporal-unit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- }
- },
- "required" : [ "lib/uuid" ],
- "type" : "object"
+ "required" : [ "lib/uuid" ],
+ "type" : "object"
+ }, {
+ "allOf" : [ ]
+ } ]
},
"metabase.lib.schema.ref.aggregation-options" : {
"default" : { },
@@ -10866,6 +12298,10 @@
"metabase.lib.schema.settings.settings" : {
"description" : "Options that tweak the behavior of the query processor.",
"properties" : {
+ "include-sensitive-fields" : {
+ "description" : "Whether to include fields with visibility_type :sensitive when fetching query metadata.",
+ "type" : "boolean"
+ },
"report-timezone" : {
"$ref" : "#/components/schemas/metabase.lib.schema.expression.temporal.timezone-id",
"description" : "The timezone the query should be ran in, overriding the default report timezone for the instance."
@@ -11082,6 +12518,31 @@
"$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
} ]
},
+ "metabase.lib.schema.template-tag.source-table" : {
+ "allOf" : [ {
+ "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"
+ },
+ "table-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "type" : {
+ "const" : "table"
+ }
+ },
+ "required" : [ "name", "display-name", "type", "table-id" ],
+ "type" : "object"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ } ]
+ },
"metabase.lib.schema.template-tag.template-tag" : {
"allOf" : [ {
"properties" : {
@@ -11100,6 +12561,8 @@
"$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"
} ]
@@ -11141,7 +12604,7 @@
},
"metabase.lib.schema.template-tag.type" : {
"description" : "Schema for valid values of template tag `:type`.",
- "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "boolean", "temporal-unit" ],
+ "enum" : [ "snippet", "card", "dimension", "number", "text", "date", "boolean", "temporal-unit", "table" ],
"type" : "string"
},
"metabase.lib.schema.template-tag.widget-type" : {
@@ -11168,237 +12631,835 @@
"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" : "string"
},
- "metabase.lib.schema.util.distinct-mbql-clauses" : { },
- "metabase.lib.schema.util.unique-uuids" : { },
- "metabase.lib.schema.validate.duplicate-column-error" : {
+ "metabase.lib.schema.test-spec.test-aggregation-spec" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-expression-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-named-expression-spec"
+ } ]
+ },
+ "metabase.lib.schema.test-spec.test-auto-bin-spec" : {
+ "const" : "auto"
+ },
+ "metabase.lib.schema.test-spec.test-bin-count-bucket-spec" : {
+ "properties" : {
+ "bins" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-auto-bin-spec"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-bin-width-bucket-spec" : {
+ "properties" : {
+ "bin-width" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-auto-bin-spec"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-breakout-spec" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-column-with-binning-spec"
+ },
+ "metabase.lib.schema.test-spec.test-card-source-spec" : {
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "type" : {
+ "const" : "card"
+ }
+ },
+ "required" : [ "type", "id" ],
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-column-spec" : {
"properties" : {
+ "display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "index" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
"name" : {
"type" : "string"
},
+ "source-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"type" : {
- "const" : "validate/duplicate-column"
+ "const" : "column"
}
},
"required" : [ "type", "name" ],
"type" : "object"
},
- "metabase.lib.schema.validate.error" : {
- "allOf" : [ {
- "properties" : {
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.validate-error-type"
- }
- },
- "required" : [ "type" ],
- "type" : "object"
- }, {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.missing-column-error"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.missing-table-alias-error"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.duplicate-column-error"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.syntax-error"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.validate.validation-exception-error"
- } ]
- } ]
- },
- "metabase.lib.schema.validate.missing-column-error" : {
+ "metabase.lib.schema.test-spec.test-column-with-binning-spec" : {
"properties" : {
+ "bin-width" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-auto-bin-spec"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "bins" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-auto-bin-spec"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "index" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
"name" : {
"type" : "string"
},
+ "source-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"type" : {
- "const" : "validate/missing-column"
+ "const" : "column"
+ },
+ "unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
}
},
"required" : [ "type", "name" ],
"type" : "object"
},
- "metabase.lib.schema.validate.missing-table-alias-error" : {
+ "metabase.lib.schema.test-spec.test-common-spec" : {
+ "properties" : {
+ "display-name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "name" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.name"
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-expression-spec" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-column-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-literal-expression-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-operator-expression-spec"
+ } ]
+ },
+ "metabase.lib.schema.test-spec.test-field-filter-spec" : {
"properties" : {
+ "alias" : {
+ "type" : "string"
+ },
+ "default" : { },
+ "dimension" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "string"
+ } ]
+ },
+ "display-name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
"name" : {
+ "minLength" : 1,
"type" : "string"
},
+ "options" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..field-filter.options"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "required" : {
+ "type" : "boolean"
+ },
"type" : {
- "const" : "validate/missing-table-alias"
+ "const" : "dimension"
+ },
+ "widget-type" : {
+ "default" : "text",
+ "description" : "The type of widget to display in the FE UI for the user to use to pick values for this parameter.",
+ "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/=" ],
+ "type" : "string"
}
},
- "required" : [ "type", "name" ],
+ "required" : [ "type", "dimension", "widget-type" ],
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-join-condition-spec" : {
+ "properties" : {
+ "left" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-join-source-spec"
+ },
+ "operator" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-operator-spec"
+ },
+ "right" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-join-source-spec"
+ }
+ },
+ "required" : [ "operator", "left", "right" ],
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-join-source-spec" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-column-with-binning-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-literal-expression-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-operator-expression-spec"
+ } ]
+ },
+ "metabase.lib.schema.test-spec.test-join-spec" : {
+ "properties" : {
+ "conditions" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-join-condition-spec"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-source-spec"
+ },
+ "strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.strategy"
+ }
+ },
+ "required" : [ "source", "strategy" ],
"type" : "object"
},
- "metabase.lib.schema.validate.syntax-error" : {
+ "metabase.lib.schema.test-spec.test-literal-expression-spec" : {
"properties" : {
"type" : {
- "const" : "validate/syntax-error"
+ "const" : "literal"
+ },
+ "value" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal.literal"
}
},
- "required" : [ "type" ],
+ "required" : [ "type", "value" ],
"type" : "object"
},
- "metabase.lib.schema.validate.validate-error-type" : {
- "type" : "string"
+ "metabase.lib.schema.test-spec.test-named-expression-spec" : {
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "value" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-expression-spec"
+ }
+ },
+ "required" : [ "name", "value" ],
+ "type" : "object"
},
- "metabase.lib.schema.validate.validation-exception-error" : {
+ "metabase.lib.schema.test-spec.test-native-query-spec" : {
"properties" : {
- "message" : {
+ "query" : {
"type" : "string"
},
- "type" : {
- "const" : "validate/validation-exception-error"
+ "template-tags" : {
+ "default" : { },
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-template-tags-spec"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "type", "message" ],
+ "required" : [ "query" ],
"type" : "object"
},
- "metabase.logger.api.log-level" : {
- "enum" : [ "off", "fatal", "error", "warn", "info", "debug", "trace" ],
- "type" : "string"
+ "metabase.lib.schema.test-spec.test-operator-expression-spec" : {
+ "properties" : {
+ "args" : {
+ "default" : [ ],
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-expression-spec"
+ },
+ "type" : "array"
+ },
+ "operator" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-operator-spec"
+ },
+ "type" : {
+ "const" : "operator"
+ }
+ },
+ "required" : [ "type", "operator", "args" ],
+ "type" : "object"
},
- "metabase.logger.api.time-unit" : {
- "enum" : [ "days", "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds" ],
+ "metabase.lib.schema.test-spec.test-operator-spec" : {
"type" : "string"
},
- "metabase.measures.api.measure" : {
- "description" : "Schema for a Measure entity as returned from the API.",
+ "metabase.lib.schema.test-spec.test-order-by-spec" : {
"properties" : {
- "archived" : {
- "type" : "boolean"
- },
- "created_at" : { },
- "creator" : {
+ "bin-width" : {
"oneOf" : [ {
- "properties" : { },
- "type" : "object"
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.bin-width"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-auto-bin-spec"
+ } ]
}, {
"type" : "null"
} ]
},
- "creator_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "definition" : {
- "properties" : { },
- "type" : "object"
+ "bins" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.binning.num-bins"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-auto-bin-spec"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "description" : {
+ "direction" : {
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.order-by.direction"
}, {
"type" : "null"
} ]
},
- "entity_id" : {
+ "display-name" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "index" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
"name" : {
- "minLength" : 1,
"type" : "string"
},
- "table_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "source-name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "updated_at" : { }
+ "type" : {
+ "const" : "column"
+ },
+ "unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "required" : [ "id", "name", "table_id", "definition", "archived", "creator_id", "created_at", "updated_at" ],
+ "required" : [ "type", "name" ],
"type" : "object"
},
- "metabase.notification.models.FullyHydratedNotification" : {
- "description" : "Fully hydrated notification.",
+ "metabase.lib.schema.test-spec.test-query-spec" : {
+ "properties" : {
+ "stages" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-stage-spec"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "stages" ],
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-raw-value-spec" : {
+ "allOf" : [ {
+ "properties" : {
+ "default" : { },
+ "display-name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "required" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag..raw-value.type"
+ }
+ },
+ "required" : [ "type" ],
+ "type" : "object"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ } ]
+ },
+ "metabase.lib.schema.test-spec.test-snippet-spec" : {
+ "allOf" : [ {
+ "properties" : {
+ "database" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ },
+ "display-name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "snippet-id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
+ },
+ "snippet-name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : {
+ "const" : "snippet"
+ }
+ },
+ "required" : [ "type" ],
+ "type" : "object"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ } ]
+ },
+ "metabase.lib.schema.test-spec.test-source-query-spec" : {
+ "allOf" : [ {
+ "properties" : {
+ "card-id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "display-name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : {
+ "const" : "card"
+ }
+ },
+ "required" : [ "type" ],
+ "type" : "object"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.disallow-dimension"
+ } ]
+ },
+ "metabase.lib.schema.test-spec.test-source-spec" : {
"oneOf" : [ {
- "oneOf" : [ {
- "properties" : {
- "creator" : {
- "oneOf" : [ {
- "properties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "handlers" : {
- "items" : {
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "recipients" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
- },
- "type" : "array"
- },
- "template" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
- }, {
- "type" : "null"
- } ]
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ],
- "type" : "object"
- },
- "type" : "array"
- },
- "payload" : {
- "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-table-source-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-card-source-spec"
+ } ]
+ },
+ "metabase.lib.schema.test-spec.test-stage-spec" : {
+ "properties" : {
+ "aggregations" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-aggregation-spec"
},
- "payload_id" : {
- "type" : "null"
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "breakouts" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-breakout-spec"
},
- "payload_type" : {
- "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "expressions" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-named-expression-spec"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fields" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-column-spec"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "filters" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-expression-spec"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "joins" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-join-spec"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "limit" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "order-bys" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-order-by-spec"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-source-spec"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-table-source-spec" : {
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "type" : {
+ "const" : "table"
+ }
+ },
+ "required" : [ "type", "id" ],
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-template-tag-spec" : {
+ "description" : "[:map [:type :metabase.lib.schema.template-tag/type]]",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-temporal-unit-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-field-filter-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-snippet-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-source-query-spec"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-raw-value-spec"
+ } ]
+ },
+ "metabase.lib.schema.test-spec.test-template-tags-spec" : {
+ "additionalProperties" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-template-tag-spec"
+ },
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-temporal-bucket-spec" : {
+ "properties" : {
+ "unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.lib.schema.test-spec.test-temporal-unit-spec" : {
+ "properties" : {
+ "alias" : {
+ "type" : "string"
+ },
+ "dimension" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "string"
+ } ]
+ },
+ "display-name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.template-tag.id"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : {
+ "const" : "temporal-unit"
+ }
+ },
+ "required" : [ "type", "dimension" ],
+ "type" : "object"
+ },
+ "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.",
+ "enum" : [ "table", "card" ],
+ "type" : "string"
+ },
+ "metabase.lib.schema.validate.validate-error-type" : {
+ "enum" : [ "missing-column", "missing-table-alias", "duplicate-column", "syntax-error", "validation-exception-error" ],
+ "type" : "string"
+ },
+ "metabase.logger.api.log-level" : {
+ "enum" : [ "off", "fatal", "error", "warn", "info", "debug", "trace" ],
+ "type" : "string"
+ },
+ "metabase.logger.api.time-unit" : {
+ "enum" : [ "days", "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds" ],
+ "type" : "string"
+ },
+ "metabase.measures.api.measure" : {
+ "description" : "Schema for a Measure entity as returned from the API.",
+ "properties" : {
+ "archived" : {
+ "type" : "boolean"
+ },
+ "created_at" : { },
+ "creator" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "definition" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "table_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "table_id", "definition", "archived", "creator_id", "created_at", "updated_at" ],
+ "type" : "object"
+ },
+ "metabase.notification.api.notification.NotificationApiInput" : {
+ "description" : "Notification schema for API input. Like FullyHydratedNotification but restricts templates\n to user-provided types only (no handlebars-resource).",
+ "oneOf" : [ {
+ "oneOf" : [ {
+ "properties" : {
+ "creator" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "handlers" : {
+ "items" : {
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "recipients" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ },
+ "type" : "array"
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "template_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "payload" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
+ },
+ "payload_id" : {
+ "type" : "null"
+ },
+ "payload_type" : {
+ "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
"type" : "string"
},
"subscriptions" : {
@@ -11460,7 +13521,7 @@
},
"template" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
@@ -11551,7 +13612,7 @@
},
"template" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
@@ -11643,7 +13704,7 @@
},
"template" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
@@ -11731,7 +13792,7 @@
},
"template" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
@@ -11813,7 +13874,7 @@
},
"template" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateUserProvided"
}, {
"type" : "null"
} ]
@@ -11844,806 +13905,4507 @@
} ]
} ]
},
- "metabase.notification.models.Notification" : {
- "oneOf" : [ {
- "properties" : {
- "payload_id" : {
- "type" : "null"
- },
- "payload_type" : {
- "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
- "type" : "string"
- }
- },
- "required" : [ "payload_type" ],
- "type" : "object"
- }, {
- "properties" : {
- "creator_id" : {
- "type" : "integer"
- },
- "payload_id" : {
- "type" : "integer"
- },
- "payload_type" : {
- "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
- "type" : "string"
- }
- },
- "required" : [ "payload_type" ],
- "type" : "object"
- }, { } ]
- },
- "metabase.notification.models.NotificationCard" : {
- "description" : "Schema for :model/NotificationCard.",
- "properties" : {
- "card" : {
- "oneOf" : [ {
- "properties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "card_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "send_condition" : {
- "enum" : [ "goal_below", "has_result", "goal_above" ],
- "type" : "string"
- },
- "send_once" : {
- "type" : "boolean"
- }
- },
- "required" : [ "card_id" ],
- "type" : "object"
- },
- "metabase.notification.models.NotificationHandler" : {
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "template_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "channel_type" ],
- "type" : "object"
- },
- "metabase.notification.models.NotificationRecipient" : {
- "description" : "Schema for :model/NotificationRecipient.",
+ "metabase.notification.models.FullyHydratedNotification" : {
+ "description" : "Fully hydrated notification.",
"oneOf" : [ {
- "properties" : {
- "details" : { },
- "notification_handler_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "permissions_group_id" : { },
- "type" : {
- "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ],
- "type" : "string"
- },
- "user_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "type", "user_id" ],
- "type" : "object"
- }, {
- "properties" : {
- "details" : { },
- "notification_handler_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "permissions_group_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : {
- "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ],
- "type" : "string"
- },
- "user_id" : { }
- },
- "required" : [ "type", "permissions_group_id" ],
- "type" : "object"
- }, {
- "properties" : {
- "details" : {
- "additionalProperties" : false,
- "properties" : {
- "value" : { }
+ "oneOf" : [ {
+ "properties" : {
+ "creator" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "value" ],
- "type" : "object"
- },
- "notification_handler_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "permissions_group_id" : { },
- "type" : {
- "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ],
- "type" : "string"
- },
- "user_id" : { }
- },
- "required" : [ "type", "details" ],
- "type" : "object"
- }, {
- "properties" : {
- "details" : {
- "additionalProperties" : false,
- "properties" : {
- "is_optional" : {
- "type" : "boolean"
+ "handlers" : {
+ "items" : {
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "recipients" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ },
+ "type" : "array"
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "template_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ],
+ "type" : "object"
},
- "pattern" : {
- "type" : "string"
- }
+ "type" : "array"
},
- "required" : [ "pattern" ],
- "type" : "object"
+ "payload" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
+ },
+ "payload_id" : {
+ "type" : "null"
+ },
+ "payload_type" : {
+ "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
+ "type" : "string"
+ },
+ "subscriptions" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
+ },
+ "type" : "array"
+ }
},
- "notification_handler_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
+ "required" : [ "payload_type", "payload" ],
+ "type" : "object"
+ }, {
+ "properties" : {
+ "creator" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "handlers" : {
+ "items" : {
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "recipients" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ },
+ "type" : "array"
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "template_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "payload_id" : {
+ "type" : "null"
+ },
+ "payload_type" : {
+ "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
+ "type" : "string"
+ },
+ "subscriptions" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "payload_type" ],
+ "type" : "object"
+ } ]
+ }, {
+ "oneOf" : [ {
+ "properties" : {
+ "creator" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "type" : "integer"
+ },
+ "handlers" : {
+ "items" : {
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "recipients" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ },
+ "type" : "array"
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "template_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "payload" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
+ },
+ "payload_id" : {
+ "type" : "integer"
+ },
+ "payload_type" : {
+ "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
+ "type" : "string"
+ },
+ "subscriptions" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "payload_type", "payload" ],
+ "type" : "object"
+ }, {
+ "properties" : {
+ "creator" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "creator_id" : {
+ "type" : "integer"
+ },
+ "handlers" : {
+ "items" : {
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "recipients" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ },
+ "type" : "array"
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "template_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "payload_id" : {
+ "type" : "integer"
+ },
+ "payload_type" : {
+ "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
+ "type" : "string"
+ },
+ "subscriptions" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "payload_type" ],
+ "type" : "object"
+ } ]
+ }, {
+ "oneOf" : [ {
+ "properties" : {
+ "creator" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "handlers" : {
+ "items" : {
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "recipients" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ },
+ "type" : "array"
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "template_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "payload" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationCard"
+ },
+ "subscriptions" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "payload" ],
+ "type" : "object"
+ }, {
+ "properties" : {
+ "creator" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "handlers" : {
+ "items" : {
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "recipients" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationRecipient"
+ },
+ "type" : "array"
+ },
+ "template" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplate"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "template_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "subscriptions" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.notification.models.NotificationSubscription"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ } ]
+ } ]
+ },
+ "metabase.notification.models.Notification" : {
+ "oneOf" : [ {
+ "properties" : {
+ "payload_id" : {
+ "type" : "null"
+ },
+ "payload_type" : {
+ "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "payload_type" ],
+ "type" : "object"
+ }, {
+ "properties" : {
+ "creator_id" : {
"type" : "integer"
},
- "permissions_group_id" : { },
- "type" : {
- "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ],
- "type" : "string"
+ "payload_id" : {
+ "type" : "integer"
+ },
+ "payload_type" : {
+ "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "payload_type" ],
+ "type" : "object"
+ }, { } ]
+ },
+ "metabase.notification.models.NotificationCard" : {
+ "description" : "Schema for :model/NotificationCard.",
+ "properties" : {
+ "card" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "card_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "send_condition" : {
+ "enum" : [ "goal_below", "has_result", "goal_above" ],
+ "type" : "string"
+ },
+ "send_once" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "card_id" ],
+ "type" : "object"
+ },
+ "metabase.notification.models.NotificationHandler" : {
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "template_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "channel_type" ],
+ "type" : "object"
+ },
+ "metabase.notification.models.NotificationRecipient" : {
+ "description" : "Schema for :model/NotificationRecipient.",
+ "oneOf" : [ {
+ "properties" : {
+ "details" : { },
+ "notification_handler_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "permissions_group_id" : { },
+ "type" : {
+ "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ],
+ "type" : "string"
+ },
+ "user_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "type", "user_id" ],
+ "type" : "object"
+ }, {
+ "properties" : {
+ "details" : { },
+ "notification_handler_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "permissions_group_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : {
+ "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ],
+ "type" : "string"
+ },
+ "user_id" : { }
+ },
+ "required" : [ "type", "permissions_group_id" ],
+ "type" : "object"
+ }, {
+ "properties" : {
+ "details" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "value" : { }
+ },
+ "required" : [ "value" ],
+ "type" : "object"
+ },
+ "notification_handler_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "permissions_group_id" : { },
+ "type" : {
+ "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ],
+ "type" : "string"
+ },
+ "user_id" : { }
+ },
+ "required" : [ "type", "details" ],
+ "type" : "object"
+ }, {
+ "properties" : {
+ "details" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "is_optional" : {
+ "type" : "boolean"
+ },
+ "pattern" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "pattern" ],
+ "type" : "object"
+ },
+ "notification_handler_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "permissions_group_id" : { },
+ "type" : {
+ "enum" : [ "notification-recipient/raw-value", "notification-recipient/user", "notification-recipient/template", "notification-recipient/group" ],
+ "type" : "string"
+ },
+ "user_id" : { }
+ },
+ "required" : [ "type", "details" ],
+ "type" : "object"
+ } ]
+ },
+ "metabase.notification.models.NotificationSubscription" : {
+ "description" : "Schema for :model/NotificationSubscription.",
+ "oneOf" : [ {
+ "properties" : {
+ "cron_schedule" : {
+ "type" : "null"
+ },
+ "event_name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "string"
+ } ]
+ },
+ "type" : {
+ "enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "event_name" ],
+ "type" : "object"
+ }, {
+ "properties" : {
+ "cron_schedule" : {
+ "type" : "string"
+ },
+ "event_name" : {
+ "type" : "null"
+ },
+ "type" : {
+ "enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ],
+ "type" : "string"
+ },
+ "ui_display_type" : {
+ "oneOf" : [ {
+ "enum" : [ "cron/raw", "cron/builder" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "type", "cron_schedule" ],
+ "type" : "object"
+ } ]
+ },
+ "metabase.parameters.schema.legacy-ref" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-expression-ref"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
+ } ]
+ },
+ "metabase.parameters.schema.parameter" : {
+ "description" : "parameter must be a map with :id and :type keys",
+ "properties" : {
+ "default" : { },
+ "filteringParameters" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
+ },
+ "mappings" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
+ },
+ "type" : "array"
+ }, {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "sectionId" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "slug" : {
+ "type" : "string"
+ },
+ "target" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ },
+ "temporal_units" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
+ },
+ "values_query_type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.values-query-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "values_source_config" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.values-source-config"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "values_source_type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.values-source-type"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "type" ],
+ "type" : "object"
+ },
+ "metabase.parameters.schema.parameter-mapping" : {
+ "description" : "parameter_mapping must be a map with :parameter_id and :target keys",
+ "properties" : {
+ "card_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashcard" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "parameter_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
+ },
+ "target" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ }
+ },
+ "required" : [ "parameter_id", "target" ],
+ "type" : "object"
+ },
+ "metabase.parameters.schema.parameter-mappings" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
+ },
+ "type" : "array"
+ },
+ "metabase.parameters.schema.parameters" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
+ },
+ "type" : "array"
+ },
+ "metabase.parameters.schema.values-query-type" : {
+ "enum" : [ "none", "list", "search" ],
+ "type" : "string"
+ },
+ "metabase.parameters.schema.values-source-config" : {
+ "description" : "Schema for valid source_options within a Parameter",
+ "properties" : {
+ "card_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "label_field" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.legacy-ref"
+ },
+ "value_field" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.legacy-ref"
+ },
+ "values" : { }
+ },
+ "type" : "object"
+ },
+ "metabase.parameters.schema.values-source-type" : {
+ "enum" : [ "static-list", "card" ],
+ "type" : "string"
+ },
+ "metabase.queries.schema..card.result-metadata" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
+ },
+ "type" : "array"
+ },
+ "metabase.queries.schema.card" : {
+ "description" : "Schema for an instance of a `:model/Card` (everything is optional to support updates).",
+ "properties" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "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"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "document_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "result_metadata" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.queries.schema.card-type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
+ },
+ "metabase.queries.schema.empty-map" : {
+ "const" : { },
+ "description" : "An empty map, allowed for Card.dataset_query for historic purposes."
+ },
+ "metabase.queries.schema.query" : {
+ "description" : "Schema for Card.dataset_query. Cards are for some wacko reason allowed to be saved with empty queries (`{}`), but not\n `NULL` ones, because the column is non-null. This sorta seems like an oversight but fixing all the tests that save\n Cards with empty queries is too much to attempt at this point. So a Card either has an empty query or a valid MBQL 5\n query.",
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.empty-map"
+ }, {
+ "allOf" : [ {
+ "description" : "Valid MBQL 5 query.",
+ "properties" : {
+ "constraints" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.constraints.constraints"
+ },
+ "create-row" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
+ },
+ "database" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ } ]
+ },
+ "info" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.info.info"
+ },
+ "lib/metadata" : {
+ "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
+ },
+ "lib/type" : {
+ "const" : "mbql/query",
+ "default" : "mbql/query"
+ },
+ "middleware" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
+ },
+ "parameters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
+ },
+ "settings" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.settings.settings"
+ },
+ "stages" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.stages"
+ },
+ "update-row" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
+ }
+ },
+ "required" : [ "lib/type", "lib/metadata", "stages" ],
+ "type" : "object"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.util.unique-uuids"
+ }, {
+ "allOf" : [ ]
+ } ]
+ } ]
+ },
+ "metabase.query-processor.schema..query-result.data" : {
+ "description" : "Schema for the :data key of query results.",
+ "properties" : {
+ "cols" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema..result-metadata.column"
+ },
+ "type" : "array"
+ },
+ "download_perms" : {
+ "type" : "string"
+ },
+ "format-rows?" : {
+ "type" : "boolean"
+ },
+ "insights" : {
+ "items" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "is_sandboxed" : {
+ "type" : "boolean"
+ },
+ "native_form" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "results_metadata" : {
+ "properties" : {
+ "columns" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema..result-metadata.column"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "columns" ],
+ "type" : "object"
+ },
+ "results_timezone" : {
+ "type" : "string"
+ },
+ "rows" : {
+ "items" : {
+ "items" : { },
+ "type" : "array"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "cols", "rows" ],
+ "type" : "object"
+ },
+ "metabase.query-processor.schema..result-metadata.column" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata",
+ "description" : "A single result metadata column as returned by the Query Processor."
+ },
+ "metabase.query-processor.schema.any-query" : {
+ "description" : "Schema for a map that is in the general shape of either a legacy MBQL or MBQL 5 query. Query may not be normalized\n yet!\n\n This schema is not very strict because we need to handle different types of queries (legacy MBQL, pMBQL,\n super-legacy MBQL, internal audit app queries, etc.) and it might not be normalized yet.",
+ "properties" : {
+ "database" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
+ } ]
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.query-processor.schema.export-format" : {
+ "description" : "Schema for valid export formats for downloading query results.",
+ "enum" : [ "csv", "api", "xlsx", "json" ],
+ "type" : "string"
+ },
+ "metabase.query-processor.schema.query-result" : {
+ "description" : "Schema for query execution results returned by the Query Processor.",
+ "properties" : {
+ "average_execution_time" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "cached" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "context" : { },
+ "data" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema..query-result.data"
+ },
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ },
+ "error" : {
+ "type" : "string"
+ },
+ "error_type" : {
+ "type" : "string"
+ },
+ "json_query" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "row_count" : {
+ "type" : "integer"
+ },
+ "running_time" : {
+ "type" : "integer"
+ },
+ "started_at" : {
+ "type" : "string"
+ },
+ "status" : {
+ "enum" : [ "completed", "failed" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "status", "row_count" ],
+ "type" : "object"
+ },
+ "metabase.sync.schedules.ExpandedSchedulesMap" : {
+ "description" : "value must be a valid map of schedule maps for a DB.",
+ "properties" : {
+ "cache_field_values" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.util.cron.ScheduleMap"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metadata_sync" : {
+ "$ref" : "#/components/schemas/metabase.util.cron.ScheduleMap"
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.task-history.api.RunEntity" : {
+ "properties" : {
+ "entity_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "entity_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_type" : {
+ "enum" : [ "dashboard", "card", "database" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "entity_type", "entity_id" ],
+ "type" : "object"
+ },
+ "metabase.task-history.api.RunFilterParams" : {
+ "properties" : {
+ "entity-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "entity-type" : {
+ "enum" : [ "dashboard", "card", "database" ],
+ "type" : "string"
+ },
+ "run-type" : {
+ "enum" : [ "alert", "sync", "fingerprint", "subscription" ],
+ "type" : "string"
+ },
+ "started-at" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "status" : {
+ "enum" : [ "started", "success", "failed", "abandoned" ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.task-history.api.TaskHistory" : {
+ "properties" : {
+ "duration" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ended_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "logs" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "run_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "started_at" : { },
+ "status" : {
+ "enum" : [ "started", "success", "failed", "unknown" ],
+ "type" : "string"
+ },
+ "task" : {
+ "type" : "string"
+ },
+ "task_details" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "task", "started_at", "ended_at", "duration", "status" ],
+ "type" : "object"
+ },
+ "metabase.task-history.api.TaskRun" : {
+ "properties" : {
+ "ended_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "entity_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_type" : {
+ "enum" : [ "dashboard", "card", "database" ],
+ "type" : "string"
+ },
+ "failed_count" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "run_type" : {
+ "enum" : [ "alert", "sync", "fingerprint", "subscription" ],
+ "type" : "string"
+ },
+ "started_at" : { },
+ "status" : {
+ "enum" : [ "started", "success", "failed", "abandoned" ],
+ "type" : "string"
+ },
+ "success_count" : {
+ "type" : "integer"
+ },
+ "task_count" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "id", "run_type", "entity_type", "entity_id", "started_at", "ended_at", "status" ],
+ "type" : "object"
+ },
+ "metabase.task-history.api.TaskRunWithTasks" : {
+ "properties" : {
+ "ended_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "entity_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_type" : {
+ "enum" : [ "dashboard", "card", "database" ],
+ "type" : "string"
+ },
+ "failed_count" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "run_type" : {
+ "enum" : [ "alert", "sync", "fingerprint", "subscription" ],
+ "type" : "string"
+ },
+ "started_at" : { },
+ "status" : {
+ "enum" : [ "started", "success", "failed", "abandoned" ],
+ "type" : "string"
+ },
+ "success_count" : {
+ "type" : "integer"
+ },
+ "task_count" : {
+ "type" : "integer"
+ },
+ "tasks" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.task-history.api.TaskHistory"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "id", "run_type", "entity_type", "entity_id", "started_at", "ended_at", "status", "tasks" ],
+ "type" : "object"
+ },
+ "metabase.task-history.api.TaskRunsResponse" : {
+ "properties" : {
+ "data" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.task-history.api.TaskRun"
+ },
+ "type" : "array"
+ },
+ "limit" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "offset" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "total" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "total", "limit", "offset", "data" ],
+ "type" : "object"
+ },
+ "metabase.tiles.api.legacy-ref" : {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field",
+ "description" : "Form-encoded JSON-encoded legacy MBQL :field ref."
+ },
+ "metabase.tiles.api.parameters" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters",
+ "description" : "Form-encoded JSON-encoded array of parameter maps."
+ },
+ "metabase.tiles.api.query" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.query",
+ "description" : "Form-encoded JSON-encoded MBQL query."
+ },
+ "metabase.timeline.api.timeline.Timeline" : {
+ "properties" : {
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "id" ],
+ "type" : "object"
+ },
+ "metabase.timeline.api.timeline.include" : {
+ "enum" : [ "events" ],
+ "type" : "string"
+ },
+ "metabase.transforms-base.util.source-table-entry" : {
+ "description" : "A source table entry in the array format. Combines alias with table reference.",
+ "properties" : {
+ "alias" : {
+ "type" : "string"
+ },
+ "database_id" : {
+ "type" : "integer"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "alias" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.alert-trigger" : {
+ "description" : "Definition for conditional alerts.\n FE evaluates condition against card results and shows alert if triggered.",
+ "properties" : {
+ "condition" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-condition"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "message" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-metadata"
+ },
+ "severity" : {
+ "enum" : [ "info", "warning", "error" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "condition", "severity", "message" ],
+ "type" : "object"
+ },
+ "metabase.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. ",
+ "properties" : {
+ "dataset_query" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.query"
+ },
+ "display" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.display-type"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.card-metadata"
+ },
+ "section_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "title" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "title", "display", "dataset_query" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.card-metadata" : {
+ "description" : "Common metadata for join-related cards and triggers.",
+ "properties" : {
+ "card_type" : {
+ "type" : "string"
+ },
+ "dedup_key" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.dedup-key"
+ },
+ "depends_on_cards" : {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ },
+ "group_id" : {
+ "type" : "string"
+ },
+ "group_order" : {
+ "type" : "integer"
+ },
+ "group_role" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.group-role"
+ },
+ "join_alias" : {
+ "type" : "string"
+ },
+ "join_step" : {
+ "type" : "integer"
+ },
+ "join_strategy" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.complexity" : {
+ "description" : "Complexity estimate for a lens.",
+ "properties" : {
+ "level" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.complexity-level"
+ },
+ "score" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "level" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.complexity-level" : {
+ "description" : "Estimated complexity/cost of generating a lens.",
+ "enum" : [ "fast", "slow", "very-slow" ],
+ "type" : "string"
+ },
+ "metabase.transforms-inspector.schema.dedup-key" : {
+ "description" : "Key for deduplicating identical queries across lenses.\n Typically a vector like [:table_count table-id].",
+ "items" : { },
+ "type" : "array"
+ },
+ "metabase.transforms-inspector.schema.discovery-response" : {
+ "description" : "Response from lens discovery.",
+ "properties" : {
+ "available_lenses" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.lens-metadata"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "sources" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.table"
+ },
+ "type" : "array"
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.inspector-status"
+ },
+ "target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.table"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visited_fields" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.visited-fields"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name", "status", "sources", "available_lenses" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.display-type" : {
+ "description" : "Valid display types for cards.",
+ "enum" : [ "bar", "row", "line", "area", "pie", "scalar", "gauge", "progress", "table", "hidden" ],
+ "type" : "string"
+ },
+ "metabase.transforms-inspector.schema.drill-lens" : {
+ "description" : "A drill-down lens available from the current lens.",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ],
+ "type" : "object"
+ },
+ "metabase.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.",
+ "properties" : {
+ "condition" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-condition"
+ },
+ "lens_id" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.trigger-metadata"
+ },
+ "params" : {
+ "additionalProperties" : { },
+ "type" : "object"
+ },
+ "reason" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "lens_id", "condition" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.field" : {
+ "description" : "Field metadata for inspector.",
+ "properties" : {
+ "base_type" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "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.transforms-inspector.schema.field-stats"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "base_type" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.field-stats" : {
+ "description" : "Statistics for a field from fingerprints.",
+ "properties" : {
+ "avg" : {
+ "type" : "number"
+ },
+ "distinct_count" : {
+ "type" : "integer"
+ },
+ "earliest" : {
+ "type" : "string"
+ },
+ "latest" : {
+ "type" : "string"
+ },
+ "max" : {
+ "type" : "number"
+ },
+ "min" : {
+ "type" : "number"
+ },
+ "nil_percent" : {
+ "type" : "number"
+ },
+ "q1" : {
+ "type" : "number"
+ },
+ "q3" : {
+ "type" : "number"
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.group-role" : {
+ "description" : "Role of a card within a comparison group.",
+ "enum" : [ "input", "output" ],
+ "type" : "string"
+ },
+ "metabase.transforms-inspector.schema.inspector-status" : {
+ "description" : "Status of the inspector result.",
+ "enum" : [ "not-run", "ready" ],
+ "type" : "string"
+ },
+ "metabase.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",
+ "enum" : [ "flat", "comparison" ],
+ "type" : "string"
+ },
+ "metabase.transforms-inspector.schema.lens" : {
+ "description" : "Full lens contents and drill lens/alert triggers.",
+ "properties" : {
+ "alert_triggers" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.alert-trigger"
+ },
+ "type" : "array"
+ },
+ "cards" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.card"
+ },
+ "type" : "array"
+ },
+ "complexity" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.complexity"
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "drill_lens_triggers" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.drill-lens-trigger"
+ },
+ "type" : "array"
+ },
+ "drill_lenses" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.drill-lens"
+ },
+ "type" : "array"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "sections" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.section"
+ },
+ "type" : "array"
+ },
+ "summary" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.lens-summary"
+ }
+ },
+ "required" : [ "id", "display_name", "sections", "cards" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.lens-metadata" : {
+ "properties" : {
+ "complexity" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.complexity"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.lens-summary" : {
+ "description" : "Summary section of a lens.",
+ "properties" : {
+ "alerts" : {
+ "items" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "highlights" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.summary-highlight"
+ },
+ "type" : "array"
+ },
+ "text" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.section" : {
+ "description" : "A section grouping cards in a lens.",
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "layout" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.layout-type"
+ },
+ "title" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "title" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.summary-highlight" : {
+ "description" : "A highlight in the lens summary.",
+ "properties" : {
+ "card_id" : {
+ "type" : "string"
+ },
+ "label" : {
+ "type" : "string"
+ },
+ "value" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "label" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.table" : {
+ "description" : "Table metadata.",
+ "properties" : {
+ "column_count" : {
+ "type" : "integer"
+ },
+ "db_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "fields" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.field"
+ },
+ "type" : "array"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "table_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_id", "table_name", "db_id", "column_count", "fields" ],
+ "type" : "object"
+ },
+ "metabase.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.",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name" ],
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.trigger-metadata" : {
+ "description" : "Common metadata for join-related cards and triggers.",
+ "properties" : {
+ "join_alias" : {
+ "type" : "string"
+ },
+ "join_step" : {
+ "type" : "integer"
+ },
+ "join_strategy" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.transforms-inspector.schema.visited-fields" : {
+ "description" : "Field IDs used in semantically important query clauses.\n Used for interestingness scoring and preselection.",
+ "properties" : {
+ "all" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ }
+ },
+ "type" : "object"
+ },
+ "metabase.transforms-rest.api.transform.run-trigger" : {
+ "enum" : [ "none", "global-schedule" ],
+ "type" : "string"
+ },
+ "metabase.transforms.schema.append-config" : {
+ "properties" : {
+ "type" : {
+ "const" : "append"
+ }
+ },
+ "required" : [ "type" ],
+ "type" : "object"
+ },
+ "metabase.transforms.schema.checkpoint-strategy" : {
+ "properties" : {
+ "checkpoint-filter" : {
+ "type" : "string"
+ },
+ "checkpoint-filter-unique-key" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.column-unique-key"
+ },
+ "type" : {
+ "const" : "checkpoint"
+ }
+ },
+ "required" : [ "type" ],
+ "type" : "object"
+ },
+ "metabase.transforms.schema.id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "metabase.transforms.schema.source-incremental-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.checkpoint-strategy"
+ } ]
+ },
+ "metabase.transforms.schema.table-incremental-target" : {
+ "properties" : {
+ "database" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target-incremental-strategy" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.target-incremental-strategy"
+ },
+ "type" : {
+ "const" : "table-incremental"
+ }
+ },
+ "required" : [ "type", "name", "target-incremental-strategy" ],
+ "type" : "object"
+ },
+ "metabase.transforms.schema.table-target" : {
+ "properties" : {
+ "database" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "const" : "table"
+ }
+ },
+ "required" : [ "type", "name" ],
+ "type" : "object"
+ },
+ "metabase.transforms.schema.target-incremental-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.append-config"
+ } ]
+ },
+ "metabase.transforms.schema.transform" : {
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "source" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
+ },
+ "target" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
+ }
+ },
+ "required" : [ "id", "name", "source", "target" ],
+ "type" : "object"
+ },
+ "metabase.transforms.schema.transform-source" : {
+ "oneOf" : [ {
+ "properties" : {
+ "query" : {
+ "$ref" : "#/components/schemas/metabase.queries.schema.query"
+ },
+ "source-incremental-strategy" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
+ },
+ "type" : {
+ "const" : "query"
+ }
+ },
+ "required" : [ "type", "query" ],
+ "type" : "object"
+ }, {
+ "properties" : {
+ "body" : {
+ "type" : "string"
+ },
+ "source-database" : {
+ "type" : "integer"
+ },
+ "source-incremental-strategy" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.source-incremental-strategy"
+ },
+ "source-tables" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.transforms-base.util.source-table-entry"
+ },
+ "type" : "array"
+ },
+ "type" : {
+ "const" : "python"
+ }
+ },
+ "required" : [ "source-tables", "type", "body" ],
+ "type" : "object"
+ } ]
+ },
+ "metabase.transforms.schema.transform-target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.table-target"
+ }, {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.table-incremental-target"
+ } ]
+ },
+ "metabase.users.schema.user-group-membership" : {
+ "description" : "Group Membership info of a User.\n In which :is_group_manager is only included if `advanced-permissions` is enabled.",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_group_manager" : {
+ "description" : "Only relevant if `advanced-permissions` is enabled. If it is, you should always include this key.",
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "id" ],
+ "type" : "object"
+ },
+ "metabase.util.cron.CronHour" : {
+ "maximum" : 23,
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "metabase.util.cron.CronMinute" : {
+ "maximum" : 59,
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "metabase.util.cron.CronScheduleString" : {
+ "description" : "value must be a valid Quartz cron schedule string.",
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "metabase.util.cron.ScheduleMap" : {
+ "description" : "value must be a valid schedule map. See schema in metabase.util.cron for details.",
+ "properties" : {
+ "schedule_day" : {
+ "oneOf" : [ {
+ "enum" : [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule_frame" : {
+ "oneOf" : [ {
+ "enum" : [ "first", "mid", "last" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule_hour" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.util.cron.CronHour"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule_minute" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.util.cron.CronMinute"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule_type" : {
+ "enum" : [ "hourly", "daily", "weekly", "monthly" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "schedule_type" ],
+ "type" : "object"
+ },
+ "metabase.warehouse-schema-rest.api.table.data-authority-write" : {
+ "description" : "Schema for writing a valid table data authority.",
+ "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ],
+ "type" : "string"
+ },
+ "metabase.warehouse-schema-rest.api.table.data-layers" : {
+ "enum" : [ "final", "internal", "hidden" ],
+ "type" : "string"
+ },
+ "metabase.warehouse-schema-rest.api.table.data-sources" : {
+ "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ],
+ "type" : "string"
+ },
+ "metabase.warehouses-rest.api.available-settings" : {
+ "additionalProperties" : {
+ "properties" : {
+ "enabled" : {
+ "type" : "boolean"
+ },
+ "reasons" : {
+ "items" : {
+ "properties" : {
+ "key" : {
+ "type" : "string"
+ },
+ "message" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, { } ]
+ },
+ "type" : {
+ "enum" : [ "error", "warning" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "key", "type", "message" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "enabled" ],
+ "type" : "object"
+ },
+ "type" : "object"
+ },
+ "metabase.xrays.api.automagic-dashboards.base-64-encoded-json" : {
+ "description" : "form-encoded base-64-encoded JSON"
+ },
+ "metabase.xrays.api.automagic-dashboards.entity-id-or-query" : {
+ "description" : "One of these:\n\n * A non-empty string with an Entity ID (including `card__<id>`-encoded Card IDs)\n\n * a form-encoded base-64-encoded JSON-encoded MBQL query\n\n * The name of a transform\n\n (Effectively since the names of transforms are unconstrained this parameter is allowed to be any form-encoded\n string.)",
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "metabot.reaction.redirect" : {
+ "properties" : {
+ "type" : {
+ "const" : "metabot.reaction/redirect"
+ },
+ "url" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "url" ],
+ "type" : "object"
+ }
+ },
+ "securitySchemes" : {
+ "ApiKeyAuth" : {
+ "description" : "Session token obtained from /api/session endpoint",
+ "in" : "header",
+ "name" : "X-Metabase-Session",
+ "type" : "apiKey"
+ }
+ }
+ },
+ "info" : {
+ "license" : {
+ "name" : "AGPL-3.0",
+ "url" : "https://www.gnu.org/licenses/agpl-3.0.html"
+ },
+ "title" : "Metabase API",
+ "version" : "v0.57.1-SNAPSHOT"
+ },
+ "openapi" : "3.1.0",
+ "paths" : {
+ "/api/action" : {
+ "get" : {
+ "description" : "Returns actions that can be used for QueryActions. By default lists all viewable actions. Pass optional\n `?model-id=<model-id>` to limit to actions on a particular model.",
+ "operationId" : "get-api-action",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "model-id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.action"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/action",
+ "tags" : [ "/api/action" ]
+ },
+ "post" : {
+ "description" : "Create a new action.",
+ "operationId" : "post-api-action",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema..action.for-insert"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.action"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/action",
+ "tags" : [ "/api/action" ]
+ }
+ },
+ "/api/action/public" : {
+ "get" : {
+ "description" : "Fetch a list of Actions with public UUIDs. These actions are publicly-accessible *if* public sharing is enabled.",
+ "operationId" : "get-api-action-public",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.action"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/action/public",
+ "tags" : [ "/api/action" ]
+ }
+ },
+ "/api/action/{action-id}" : {
+ "delete" : {
+ "description" : "Delete an Action.",
+ "operationId" : "delete-api-action-action-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "action-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "DELETE /api/action/{action-id}",
+ "tags" : [ "/api/action" ]
+ },
+ "get" : {
+ "description" : "Fetch an Action.",
+ "operationId" : "get-api-action-action-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "action-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.action"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/action/{action-id}",
+ "tags" : [ "/api/action" ]
+ }
+ },
+ "/api/action/{action-id}/execute" : {
+ "get" : {
+ "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",
+ "operationId" : "get-api-action-action-id-execute",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "action-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be a valid JSON string.",
+ "in" : "query",
+ "name" : "parameters",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/action/{action-id}/execute",
+ "tags" : [ "/api/action" ]
+ }
+ },
+ "/api/action/{id}" : {
+ "put" : {
+ "description" : "Update an Action.",
+ "operationId" : "put-api-action-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema..action.for-update"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "PUT /api/action/{id}",
+ "tags" : [ "/api/action" ]
+ }
+ },
+ "/api/action/{id}/execute" : {
+ "post" : {
+ "description" : "Execute the Action.\n\n `parameters` should be the mapped dashboard parameters with values.",
+ "operationId" : "post-api-action-id-execute",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "oneOf" : [ {
+ "properties" : {
+ "parameters" : {
+ "oneOf" : [ {
+ "additionalProperties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/action/{id}/execute",
+ "tags" : [ "/api/action" ]
+ }
+ },
+ "/api/action/{id}/public_link" : {
+ "delete" : {
+ "description" : "Delete the publicly-accessible link to this Dashboard.",
+ "operationId" : "delete-api-action-id-public_link",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "DELETE /api/action/{id}/public_link",
+ "tags" : [ "/api/action" ]
+ },
+ "post" : {
+ "description" : "Generate publicly-accessible links for this Action. Returns UUID to be used in public links. (If this\n Action has already been shared, it will return the existing public link rather than creating a new one.) Public\n sharing must be enabled.",
+ "operationId" : "post-api-action-id-public_link",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/action/{id}/public_link",
+ "tags" : [ "/api/action" ]
+ }
+ },
+ "/api/activity/most_recently_viewed_dashboard" : {
+ "get" : {
+ "description" : "Get the most recently viewed dashboard for the current user. Returns a 204 if the user has not viewed any dashboards\n in the last 24 hours.",
+ "operationId" : "get-api-activity-most_recently_viewed_dashboard",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/activity/most_recently_viewed_dashboard",
+ "tags" : [ "/api/activity" ]
+ }
+ },
+ "/api/activity/popular_items" : {
+ "get" : {
+ "description" : "Get the list of 5 popular things on the instance. Query takes 8 and limits to 5 so that if it finds anything\n archived, deleted, etc it can usually still get 5. ",
+ "operationId" : "get-api-activity-popular_items",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/activity/popular_items",
+ "tags" : [ "/api/activity" ]
+ }
+ },
+ "/api/activity/recent_views" : {
+ "get" : {
+ "deprecated" : true,
+ "description" : "Get a list of 100 models (cards, models, tables, dashboards, and collections) that the current user has been viewing most\n recently. Return a maximum of 20 model of each, if they've looked at at least 20.",
+ "operationId" : "get-api-activity-recent_views",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/activity/recent_views",
+ "tags" : [ "/api/activity" ]
+ }
+ },
+ "/api/activity/recents" : {
+ "get" : {
+ "description" : "Get a list of recent items the current user has been viewing most recently under the `:recents` key.\n Allows for filtering by context: views or selections",
+ "operationId" : "get-api-activity-recents",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "context",
+ "required" : true,
+ "schema" : {
+ "items" : {
+ "enum" : [ "selections", "views" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ }, {
+ "in" : "query",
+ "name" : "include_metadata",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/activity/recents",
+ "tags" : [ "/api/activity" ]
+ },
+ "post" : {
+ "description" : "Adds a model to the list of recently selected items.",
+ "operationId" : "post-api-activity-recents",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "context" : {
+ "enum" : [ "selection" ],
+ "type" : "string"
+ },
+ "model" : {
+ "enum" : [ "card", "dataset", "metric", "dashboard", "table", "collection", "document" ],
+ "type" : "string"
+ },
+ "model_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "model", "model_id", "context" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/activity/recents",
+ "tags" : [ "/api/activity" ]
+ }
+ },
+ "/api/agent/v1/construct-query" : {
+ "post" : {
+ "description" : "Construct an MBQL query from a table or metric.\n\n Returns a base64-encoded MBQL query that can be used with the query API.\n\n For tables, supports: filters, fields, aggregations, group_by, order_by, limit.\n For metrics, supports: filters, group_by (aggregation is defined by the metric).",
+ "operationId" : "post-api-agent-v1-construct-query",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.construct-query-request"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.construct-query-response"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/agent/v1/construct-query",
+ "tags" : [ "/api/agent" ]
+ }
+ },
+ "/api/agent/v1/execute" : {
+ "post" : {
+ "description" : "Execute an MBQL query and return results.\n\n Accepts a base64-encoded MBQL query (as returned by /v1/construct-query) and executes it,\n returning results with column metadata.\n\n Response format:\n - On success: {:data {:cols [...] :rows [...]} :row_count N :status :completed :running_time M}\n - On failure: {:status :failed :error \"message\" ...}\n\n Standard userspace query limits are enforced (2000 rows for simple queries, 10000 for aggregated).",
+ "operationId" : "post-api-agent-v1-execute",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.execute-query-request"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.execute-query-response"
+ }
+ }
},
- "user_id" : { }
+ "description" : "Successful response"
},
- "required" : [ "type", "details" ],
- "type" : "object"
- } ]
- },
- "metabase.notification.models.NotificationSubscription" : {
- "description" : "Schema for :model/NotificationSubscription.",
- "oneOf" : [ {
- "properties" : {
- "cron_schedule" : {
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/agent/v1/execute",
+ "tags" : [ "/api/agent" ]
+ }
+ },
+ "/api/agent/v1/metric/{id}" : {
+ "get" : {
+ "description" : "Get details for a metric by ID.",
+ "operationId" : "get-api-agent-v1-metric-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-default-temporal-breakout",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
"type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-field-values",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-queryable-dimensions",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-segments",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.metric"
+ }
+ }
},
- "event_name" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "string"
- } ]
- },
- "type" : {
- "enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ],
- "type" : "string"
- }
+ "description" : "Successful response"
},
- "required" : [ "type", "event_name" ],
- "type" : "object"
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/agent/v1/metric/{id}",
+ "tags" : [ "/api/agent" ]
+ }
+ },
+ "/api/agent/v1/metric/{id}/field/{field-id}/values" : {
+ "get" : {
+ "description" : "Get statistics and sample values for a metric field.",
+ "operationId" : "get-api-agent-v1-metric-id-field-field-id-values",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
}, {
- "properties" : {
- "cron_schedule" : {
- "type" : "string"
- },
- "event_name" : {
- "type" : "null"
+ "in" : "path",
+ "name" : "field-id",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field-values"
+ }
+ }
},
- "type" : {
- "enum" : [ "notification-subscription/cron", "notification-subscription/system-event" ],
- "type" : "string"
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/agent/v1/metric/{id}/field/{field-id}/values",
+ "tags" : [ "/api/agent" ]
+ }
+ },
+ "/api/agent/v1/ping" : {
+ "get" : {
+ "description" : "Health check endpoint for the Agent API.",
+ "operationId" : "get-api-agent-v1-ping",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "message" ],
+ "type" : "object"
+ }
+ }
},
- "ui_display_type" : {
- "oneOf" : [ {
- "enum" : [ "cron/raw", "cron/builder" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/agent/v1/ping",
+ "tags" : [ "/api/agent" ]
+ }
+ },
+ "/api/agent/v1/search" : {
+ "post" : {
+ "description" : "Search for tables and metrics.\n\n Supports both term-based and semantic search queries. Results are ranked using\n Reciprocal Rank Fusion when both query types are provided.",
+ "operationId" : "post-api-agent-v1-search",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "semantic_queries" : {
+ "oneOf" : [ {
+ "items" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "term_queries" : {
+ "oneOf" : [ {
+ "items" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ }
}
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.search-response"
+ }
+ }
+ },
+ "description" : "Successful response"
},
- "required" : [ "type", "cron_schedule" ],
- "type" : "object"
- } ]
- },
- "metabase.parameters.schema.legacy-ref" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-expression-ref"
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/agent/v1/search",
+ "tags" : [ "/api/agent" ]
+ }
+ },
+ "/api/agent/v1/table/{id}" : {
+ "get" : {
+ "description" : "Get details for a table by ID.",
+ "operationId" : "get-api-agent-v1-table-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter..target.legacy-field-ref"
- } ]
- },
- "metabase.parameters.schema.parameter" : {
- "description" : "parameter must be a map with :id and :type keys",
- "properties" : {
- "default" : { },
- "filteringParameters" : {
+ "in" : "query",
+ "name" : "with-field-values",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
- },
- "type" : "array"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
- },
- "mappings" : {
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-fields",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "anyOf" : [ {
- "items" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
- },
- "type" : "array"
- }, {
- "items" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
- },
- "type" : "array",
- "uniqueItems" : true
- } ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-related-tables",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-metrics",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-measures",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "with-segments",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.table"
+ }
+ }
+ },
+ "description" : "Successful response"
},
- "name" : {
- "type" : "string"
- },
- "sectionId" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ "4XX" : {
+ "description" : "Client error response"
},
- "slug" : {
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/agent/v1/table/{id}",
+ "tags" : [ "/api/agent" ]
+ }
+ },
+ "/api/agent/v1/table/{id}/field/{field-id}/values" : {
+ "get" : {
+ "description" : "Get statistics and sample values for a table field.",
+ "operationId" : "get-api-agent-v1-table-id-field-field-id-values",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "path",
+ "name" : "field-id",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
"type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.agent-api.api.field-values"
+ }
+ }
+ },
+ "description" : "Successful response"
},
- "target" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ "4XX" : {
+ "description" : "Client error response"
},
- "temporal_units" : {
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/agent/v1/table/{id}/field/{field-id}/values",
+ "tags" : [ "/api/agent" ]
+ }
+ },
+ "/api/alert" : {
+ "get" : {
+ "description" : "Fetch alerts which the current user has created or will receive, or all alerts if the user is an admin.\n The optional `user_id` will return alerts created by the corresponding user, but is ignored for non-admin users.",
+ "operationId" : "get-api-alert",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "archived",
+ "required" : true,
+ "schema" : {
+ "default" : false,
"oneOf" : [ {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
- },
- "type" : "array"
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "user_id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/alert",
+ "tags" : [ "/api/alert" ]
+ }
+ },
+ "/api/alert/{id}" : {
+ "get" : {
+ "description" : "Fetch an alert by ID",
+ "operationId" : "get-api-alert-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/alert/{id}",
+ "tags" : [ "/api/alert" ]
+ }
+ },
+ "/api/alert/{id}/subscription" : {
+ "delete" : {
+ "description" : "For users to unsubscribe themselves from the given alert.",
+ "operationId" : "delete-api-alert-id-subscription",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "DELETE /api/alert/{id}/subscription",
+ "tags" : [ "/api/alert" ]
+ }
+ },
+ "/api/analytics/anonymous-stats" : {
+ "get" : {
+ "description" : "Anonymous usage stats. Endpoint for testing, and eventually exposing this to instance admins to let them see\n what is being phoned home.",
+ "operationId" : "get-api-analytics-anonymous-stats",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.type"
+ "4XX" : {
+ "description" : "Client error response"
},
- "values_query_type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.values-query-type"
- }, {
- "type" : "null"
- } ]
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/analytics/anonymous-stats",
+ "tags" : [ "/api/analytics" ]
+ }
+ },
+ "/api/api-key" : {
+ "get" : {
+ "description" : "Get a list of API keys with the default scope. Non-paginated.",
+ "operationId" : "get-api-api-key",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "values_source_config" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.values-source-config"
- }, {
- "type" : "null"
- } ]
+ "4XX" : {
+ "description" : "Client error response"
},
- "values_source_type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.values-source-type"
- }, {
- "type" : "null"
- } ]
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "required" : [ "id", "type" ],
- "type" : "object"
+ "summary" : "GET /api/api-key",
+ "tags" : [ "/api/api-key" ]
},
- "metabase.parameters.schema.parameter-mapping" : {
- "description" : "parameter_mapping must be a map with :parameter_id and :target keys",
- "properties" : {
- "card_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }, {
- "type" : "null"
- } ]
+ "post" : {
+ "description" : "Create a new API key (and an associated `User`) with the provided name and group ID.",
+ "operationId" : "post-api-api-key",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "group_id" : {
+ "$ref" : "#/components/schemas/metabase.api-keys.schema.id"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "group_id", "name" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "dashcard" : {
- "properties" : { },
- "type" : "object"
+ "4XX" : {
+ "description" : "Client error response"
},
- "parameter_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/api-key",
+ "tags" : [ "/api/api-key" ]
+ }
+ },
+ "/api/api-key/count" : {
+ "get" : {
+ "description" : "Get the count of API keys in the DB with the default scope.",
+ "operationId" : "get-api-api-key-count",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "target" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.target"
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "required" : [ "parameter_id", "target" ],
- "type" : "object"
- },
- "metabase.parameters.schema.parameter-mappings" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
+ "summary" : "GET /api/api-key/count",
+ "tags" : [ "/api/api-key" ]
+ }
+ },
+ "/api/api-key/{id}" : {
+ "delete" : {
+ "description" : "Delete an ApiKey",
+ "operationId" : "delete-api-api-key-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.api-keys.schema.id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
},
- "type" : "array"
+ "summary" : "DELETE /api/api-key/{id}",
+ "tags" : [ "/api/api-key" ]
},
- "metabase.parameters.schema.parameters" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
+ "put" : {
+ "description" : "Update an API key by changing its group and/or its name",
+ "operationId" : "put-api-api-key-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "group_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.api-keys.schema.name"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
},
- "type" : "array"
- },
- "metabase.parameters.schema.values-query-type" : {
- "enum" : [ "none", "list", "search" ],
- "type" : "string"
- },
- "metabase.parameters.schema.values-source-config" : {
- "description" : "Schema for valid source_options within a Parameter",
- "properties" : {
- "card_id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "label_field" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.legacy-ref"
+ "4XX" : {
+ "description" : "Client error response"
},
- "value_field" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.legacy-ref"
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "PUT /api/api-key/{id}",
+ "tags" : [ "/api/api-key" ]
+ }
+ },
+ "/api/api-key/{id}/regenerate" : {
+ "put" : {
+ "description" : "Regenerate an API Key",
+ "operationId" : "put-api-api-key-id-regenerate",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.api-keys.schema.id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.api-keys.schema.id"
+ },
+ "masked_key" : {
+ "$ref" : "#/components/schemas/metabase.api-keys.schema..key.masked"
+ },
+ "prefix" : {
+ "$ref" : "#/components/schemas/metabase.api-keys.schema.prefix"
+ },
+ "unmasked_key" : {
+ "$ref" : "#/components/schemas/metabase.api-keys.schema..key.raw"
+ }
+ },
+ "required" : [ "id", "unmasked_key", "masked_key", "prefix" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Successful response"
},
- "values" : { }
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
},
- "type" : "object"
- },
- "metabase.parameters.schema.values-source-type" : {
- "enum" : [ "static-list", "card" ],
- "type" : "string"
- },
- "metabase.queries.schema..card.result-metadata" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.lib-or-legacy-column"
+ "summary" : "PUT /api/api-key/{id}/regenerate",
+ "tags" : [ "/api/api-key" ]
+ }
+ },
+ "/api/automagic-dashboards/database/{id}/candidates" : {
+ "get" : {
+ "description" : "Return a list of candidates for automagic dashboards ordered by interestingness.",
+ "operationId" : "get-api-automagic-dashboards-database-id-candidates",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
},
- "type" : "array"
- },
- "metabase.queries.schema.card" : {
- "description" : "Schema for an instance of a `:model/Card` (everything is optional to support updates).",
- "properties" : {
- "collection_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.collection"
- }, {
- "type" : "null"
- } ]
+ "summary" : "GET /api/automagic-dashboards/database/{id}/candidates",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/model_index/{model-index-id}/primary_key/{pk-id}" : {
+ "get" : {
+ "description" : "Return an automagic dashboard for an entity detail specified by `entity`\n with id `id` and a primary key of `indexed-value`.",
+ "operationId" : "get-api-automagic-dashboards-model_index-model-index-id-primary_key-pk-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "model-index-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ }
+ }, {
+ "in" : "path",
+ "name" : "pk-id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "dashboard_id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
- }, {
- "type" : "null"
- } ]
+ "4XX" : {
+ "description" : "Client error response"
},
- "database_id" : {
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/automagic-dashboards/model_index/{model-index-id}/primary_key/{pk-id}",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/{entity}/{entity-id-or-query}" : {
+ "get" : {
+ "description" : "Return an automagic dashboard for entity `entity` with id `id`.",
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "in" : "query",
+ "name" : "show",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ "anyOf" : [ {
+ "const" : "all"
+ }, {
+ "minimum" : 0,
+ "type" : "integer"
+ } ]
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "dataset_query" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.query"
- }, {
- "type" : "null"
- } ]
+ "4XX" : {
+ "description" : "Client error response"
},
- "description" : {
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}" : {
+ "get" : {
+ "description" : "Return an automagic dashboard analyzing cell in automagic dashboard for entity `entity` defined by query\n `cell-query`.",
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-cell-cell-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "in" : "path",
+ "name" : "cell-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.base-64-encoded-json"
+ }
+ }, {
+ "description" : "invalid show value",
+ "in" : "query",
+ "name" : "show",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "enum" : [ "all" ],
+ "type" : "string"
+ }, {
+ "minimum" : 0,
+ "type" : "integer"
+ } ]
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "document_id" : {
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
+ "get" : {
+ "description" : "Return an automagic comparison dashboard for cell in automagic dashboard for entity `entity`\n with id `id` defined by query `cell-query`; compared with entity `comparison-entity` with id\n `comparison-entity-id-or-query.`.",
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-cell-cell-query-compare-comparison-entity-comparison-entity-id-or-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "in" : "path",
+ "name" : "cell-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.base-64-encoded-json"
+ }
+ }, {
+ "description" : "Invalid comparison entity type. Can only be one of \"table\", \"segment\", or \"adhoc\"",
+ "in" : "path",
+ "name" : "comparison-entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "segment", "table" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "comparison-entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "description" : "invalid show value",
+ "in" : "query",
+ "name" : "show",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.documents.schema..document.id"
+ "anyOf" : [ {
+ "enum" : [ "all" ],
+ "type" : "string"
+ }, {
+ "minimum" : 0,
+ "type" : "integer"
+ } ]
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "id" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }, {
- "type" : "null"
- } ]
+ "4XX" : {
+ "description" : "Client error response"
},
- "name" : {
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}" : {
+ "get" : {
+ "description" : "Return an automagic dashboard analyzing cell in question with id `id` defined by query `cell-query` using\n dashboard-template `dashboard-template`.",
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-cell-cell-query-rule-prefix-dashboard-template",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : { }
+ }, {
+ "description" : "invalid value for dashboard template name",
+ "in" : "path",
+ "name" : "dashboard-template",
+ "required" : true,
+ "schema" : { }
+ }, {
+ "in" : "path",
+ "name" : "cell-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.base-64-encoded-json"
+ }
+ }, {
+ "description" : "invalid show value",
+ "in" : "query",
+ "name" : "show",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "enum" : [ "all" ],
+ "type" : "string"
+ }, {
+ "minimum" : 0,
+ "type" : "integer"
+ } ]
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "parameter_mappings" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
- }, {
- "type" : "null"
- } ]
+ "4XX" : {
+ "description" : "Client error response"
},
- "parameters" : {
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
+ "get" : {
+ "description" : "Return an automagic comparison dashboard for cell in automagic dashboard for entity `entity`\n with id `id` defined by query `cell-query` using dashboard-template `dashboard-template`; compared with entity\n `comparison-entity` with id `comparison-entity-id-or-query.`.",
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-cell-cell-query-rule-prefix-dashboard-template-compare-comparison-entity-comparison-entity-id-or-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : { }
+ }, {
+ "description" : "invalid value for dashboard template name",
+ "in" : "path",
+ "name" : "dashboard-template",
+ "required" : true,
+ "schema" : { }
+ }, {
+ "in" : "path",
+ "name" : "cell-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.base-64-encoded-json"
+ }
+ }, {
+ "description" : "Invalid comparison entity type. Can only be one of \"table\", \"segment\", or \"adhoc\"",
+ "in" : "path",
+ "name" : "comparison-entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "segment", "table" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "comparison-entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "description" : "invalid show value",
+ "in" : "query",
+ "name" : "show",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ "anyOf" : [ {
+ "enum" : [ "all" ],
+ "type" : "string"
+ }, {
+ "minimum" : 0,
+ "type" : "integer"
+ } ]
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "result_metadata" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema..card.result-metadata"
- }, {
- "type" : "null"
- } ]
+ "4XX" : {
+ "description" : "Client error response"
},
- "type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
- }, {
- "type" : "null"
- } ]
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "type" : "object"
- },
- "metabase.queries.schema.card-type" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..card.type"
- },
- "metabase.queries.schema.empty-map" : {
- "const" : { },
- "description" : "An empty map, allowed for Card.dataset_query for historic purposes."
- },
- "metabase.queries.schema.query" : {
- "description" : "Schema for Card.dataset_query. Cards are for some wacko reason allowed to be saved with empty queries (`{}`), but not\n `NULL` ones, because the column is non-null. This sorta seems like an oversight but fixing all the tests that save\n Cards with empty queries is too much to attempt at this point. So a Card either has an empty query or a valid MBQL 5\n query.",
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.empty-map"
+ "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/{entity}/{entity-id-or-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
+ "get" : {
+ "description" : "Return an automagic comparison dashboard for entity `entity` with id `id` compared with entity `comparison-entity`\n with id `comparison-entity-id-or-query.`",
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-compare-comparison-entity-comparison-entity-id-or-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
}, {
- "allOf" : [ {
- "description" : "Valid MBQL 5 query.",
- "properties" : {
- "constraints" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.constraints.constraints"
- },
- "create-row" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
- },
- "database" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- } ]
- },
- "info" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.info.info"
- },
- "lib/metadata" : {
- "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
- },
- "lib/type" : {
- "const" : "mbql/query",
- "default" : "mbql/query"
- },
- "middleware" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.middleware-options.middleware-options"
- },
- "parameters" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
- },
- "settings" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.settings.settings"
- },
- "stages" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.stages"
- },
- "update-row" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.actions.row"
- }
- },
- "required" : [ "lib/type", "lib/metadata", "stages" ],
- "type" : "object"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.util.unique-uuids"
- }, {
- "allOf" : [ ]
- } ]
- } ]
- },
- "metabase.query-processor.schema..result-metadata.column" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata",
- "description" : "A single result metadata column as returned by the Query Processor."
- },
- "metabase.query-processor.schema.any-query" : {
- "description" : "Schema for a map that is in the general shape of either a legacy MBQL or MBQL 5 query. Query may not be normalized\n yet!\n\n This schema is not very strict because we need to handle different types of queries (legacy MBQL, pMBQL,\n super-legacy MBQL, internal audit app queries, etc.) and it might not be normalized yet.",
- "properties" : {
- "database" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
- }, {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.saved-questions-virtual-database"
- } ]
+ "in" : "path",
+ "name" : "entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
+ "type" : "string"
}
- },
- "type" : "object"
- },
- "metabase.query-processor.schema.export-format" : {
- "description" : "Schema for valid export formats for downloading query results.",
- "enum" : [ "csv", "api", "xlsx", "json" ],
- "type" : "string"
- },
- "metabase.sync.schedules.ExpandedSchedulesMap" : {
- "description" : "value must be a valid map of schedule maps for a DB.",
- "properties" : {
- "cache_field_values" : {
+ }, {
+ "description" : "Invalid comparison entity type. Can only be one of \"table\", \"segment\", or \"adhoc\"",
+ "in" : "path",
+ "name" : "comparison-entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "segment", "table" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "comparison-entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "description" : "invalid show value",
+ "in" : "query",
+ "name" : "show",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.util.cron.ScheduleMap"
+ "anyOf" : [ {
+ "enum" : [ "all" ],
+ "type" : "string"
+ }, {
+ "minimum" : 0,
+ "type" : "integer"
+ } ]
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "metadata_sync" : {
- "$ref" : "#/components/schemas/metabase.util.cron.ScheduleMap"
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "type" : "object"
- },
- "metabase.task-history.api.RunEntity" : {
- "properties" : {
- "entity_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/{entity}/{entity-id-or-query}/query_metadata" : {
+ "get" : {
+ "description" : "Return all metadata for an automagic dashboard for entity `entity` with id `id`.",
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-query_metadata",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "entity_name" : {
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/query_metadata",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}" : {
+ "get" : {
+ "description" : "Return an automagic dashboard for entity `entity` with id `id` using dashboard-template `dashboard-template`.",
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-rule-prefix-dashboard-template",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : { }
+ }, {
+ "description" : "invalid value for dashboard template name",
+ "in" : "path",
+ "name" : "dashboard-template",
+ "required" : true,
+ "schema" : { }
+ }, {
+ "description" : "invalid show value",
+ "in" : "query",
+ "name" : "show",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "type" : "string"
+ "anyOf" : [ {
+ "enum" : [ "all" ],
+ "type" : "string"
+ }, {
+ "minimum" : 0,
+ "type" : "integer"
+ } ]
}, {
"type" : "null"
} ]
- },
- "entity_type" : {
- "enum" : [ "dashboard", "card", "database" ],
- "type" : "string"
}
- },
- "required" : [ "entity_type", "entity_id" ],
- "type" : "object"
- },
- "metabase.task-history.api.RunFilterParams" : {
- "properties" : {
- "entity-id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "entity-type" : {
- "enum" : [ "dashboard", "card", "database" ],
- "type" : "string"
+ "4XX" : {
+ "description" : "Client error response"
},
- "run-type" : {
- "enum" : [ "alert", "sync", "fingerprint", "subscription" ],
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
+ "get" : {
+ "description" : "Return an automagic comparison dashboard for entity `entity` with id `id` using dashboard-template\n `dashboard-template`; compared with entity `comparison-entity` with id `comparison-entity-id-or-query.`.",
+ "operationId" : "get-api-automagic-dashboards-entity-entity-id-or-query-rule-prefix-dashboard-template-compare-comparison-entity-comparison-entity-id-or-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
"type" : "string"
- },
- "status" : {
- "enum" : [ "started", "success", "failed", "abandoned" ],
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : { }
+ }, {
+ "description" : "invalid value for dashboard template name",
+ "in" : "path",
+ "name" : "dashboard-template",
+ "required" : true,
+ "schema" : { }
+ }, {
+ "description" : "Invalid comparison entity type. Can only be one of \"table\", \"segment\", or \"adhoc\"",
+ "in" : "path",
+ "name" : "comparison-entity",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "adhoc", "segment", "table" ],
"type" : "string"
}
- },
- "type" : "object"
- },
- "metabase.task-history.api.TaskHistory" : {
- "properties" : {
- "duration" : {
+ }, {
+ "in" : "path",
+ "name" : "comparison-entity-id-or-query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ }
+ }, {
+ "description" : "invalid show value",
+ "in" : "query",
+ "name" : "show",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "type" : "integer"
+ "anyOf" : [ {
+ "enum" : [ "all" ],
+ "type" : "string"
+ }, {
+ "minimum" : 0,
+ "type" : "integer"
+ } ]
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "ended_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "logs" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "run_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "4XX" : {
+ "description" : "Client error response"
},
- "started_at" : { },
- "status" : {
- "enum" : [ "started", "success", "failed", "unknown" ],
- "type" : "string"
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
+ "tags" : [ "/api/automagic-dashboards" ]
+ }
+ },
+ "/api/bookmark" : {
+ "get" : {
+ "description" : "Fetch all bookmarks for the user",
+ "operationId" : "get-api-bookmark",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "task" : {
- "type" : "string"
+ "4XX" : {
+ "description" : "Client error response"
},
- "task_details" : {
- "oneOf" : [ {
- "properties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "required" : [ "id", "task", "started_at", "ended_at", "duration", "status" ],
- "type" : "object"
- },
- "metabase.task-history.api.TaskRun" : {
- "properties" : {
- "ended_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "entity_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "summary" : "GET /api/bookmark",
+ "tags" : [ "/api/bookmark" ]
+ }
+ },
+ "/api/bookmark/ordering" : {
+ "put" : {
+ "description" : "Sets the order of bookmarks for user.",
+ "operationId" : "put-api-bookmark-ordering",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "orderings" : {
+ "items" : {
+ "properties" : {
+ "item_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : {
+ "enum" : [ "card", "dashboard", "collection", "document" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "type", "item_id" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "orderings" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "entity_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "4XX" : {
+ "description" : "Client error response"
},
- "entity_type" : {
- "enum" : [ "dashboard", "card", "database" ],
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "PUT /api/bookmark/ordering",
+ "tags" : [ "/api/bookmark" ]
+ }
+ },
+ "/api/bookmark/{model}/{id}" : {
+ "delete" : {
+ "description" : "Delete a bookmark. Will delete a bookmark assigned to the user making the request by model and id.",
+ "operationId" : "delete-api-bookmark-model-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "model",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "card", "dashboard", "collection", "document" ],
"type" : "string"
- },
- "failed_count" : {
- "type" : "integer"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
"minimum" : 1,
"type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "run_type" : {
- "enum" : [ "alert", "sync", "fingerprint", "subscription" ],
- "type" : "string"
- },
- "started_at" : { },
- "status" : {
- "enum" : [ "started", "success", "failed", "abandoned" ],
- "type" : "string"
- },
- "success_count" : {
- "type" : "integer"
+ "4XX" : {
+ "description" : "Client error response"
},
- "task_count" : {
- "type" : "integer"
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "required" : [ "id", "run_type", "entity_type", "entity_id", "started_at", "ended_at", "status" ],
- "type" : "object"
+ "summary" : "DELETE /api/bookmark/{model}/{id}",
+ "tags" : [ "/api/bookmark" ]
},
- "metabase.task-history.api.TaskRunWithTasks" : {
- "properties" : {
- "ended_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "entity_id" : {
- "description" : "value must be an integer greater than zero.",
+ "post" : {
+ "description" : "Create a new bookmark for user.",
+ "operationId" : "post-api-bookmark-model-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "model",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "card", "dashboard", "collection", "document" ],
+ "type" : "string"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
"minimum" : 1,
"type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "entity_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "entity_type" : {
- "enum" : [ "dashboard", "card", "database" ],
- "type" : "string"
+ "4XX" : {
+ "description" : "Client error response"
},
- "failed_count" : {
- "type" : "integer"
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/bookmark/{model}/{id}",
+ "tags" : [ "/api/bookmark" ]
+ }
+ },
+ "/api/bug-reporting/connection-pool-details" : {
+ "get" : {
+ "description" : "Returns database connection pool info for the current Metabase instance.",
+ "operationId" : "get-api-bug-reporting-connection-pool-details",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "4XX" : {
+ "description" : "Client error response"
},
- "run_type" : {
- "enum" : [ "alert", "sync", "fingerprint", "subscription" ],
- "type" : "string"
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/bug-reporting/connection-pool-details",
+ "tags" : [ "/api/bug-reporting" ]
+ }
+ },
+ "/api/bug-reporting/details" : {
+ "get" : {
+ "description" : "Returns version and system information relevant to filing a bug report against Metabase.",
+ "operationId" : "get-api-bug-reporting-details",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "started_at" : { },
- "status" : {
- "enum" : [ "started", "success", "failed", "abandoned" ],
- "type" : "string"
+ "4XX" : {
+ "description" : "Client error response"
},
- "success_count" : {
- "type" : "integer"
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/bug-reporting/details",
+ "tags" : [ "/api/bug-reporting" ]
+ }
+ },
+ "/api/cache" : {
+ "delete" : {
+ "description" : "Delete cache configurations.",
+ "operationId" : "delete-api-cache",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "model" : {
+ "enum" : [ "root", "database", "dashboard", "question" ],
+ "type" : "string"
+ },
+ "model_id" : {
+ "items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "model", "model_id" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "task_count" : {
- "type" : "integer"
+ "4XX" : {
+ "description" : "Client error response"
},
- "tasks" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.task-history.api.TaskHistory"
- },
- "type" : "array"
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "required" : [ "id", "run_type", "entity_type", "entity_id", "started_at", "ended_at", "status", "tasks" ],
- "type" : "object"
+ "summary" : "DELETE /api/cache",
+ "tags" : [ "/api/cache" ]
},
- "metabase.task-history.api.TaskRunsResponse" : {
- "properties" : {
- "data" : {
+ "get" : {
+ "description" : "Return cache configuration. Supports pagination via `limit` and `offset` query parameters,\n and sorting via `sort_column` and `sort_direction`.",
+ "operationId" : "get-api-cache",
+ "parameters" : [ {
+ "description" : "Type of model",
+ "in" : "query",
+ "name" : "model",
+ "required" : true,
+ "schema" : {
+ "default" : [ "root" ],
"items" : {
- "$ref" : "#/components/schemas/metabase.task-history.api.TaskRun"
+ "enum" : [ "root", "database", "dashboard", "question" ],
+ "type" : "string"
},
"type" : "array"
- },
- "limit" : {
+ }
+ }, {
+ "description" : "Collection id to filter results. Returns everything if not supplied.",
+ "in" : "query",
+ "name" : "collection",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
@@ -12651,223 +18413,421 @@
}, {
"type" : "null"
} ]
- },
- "offset" : {
+ }
+ }, {
+ "description" : "Model id to get configuration for.",
+ "in" : "query",
+ "name" : "id",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
"type" : "integer"
}, {
"type" : "null"
} ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort_column",
+ "required" : true,
+ "schema" : {
+ "default" : "name",
+ "enum" : [ "name", "policy", "collection" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort_direction",
+ "required" : true,
+ "schema" : {
+ "default" : "asc",
+ "enum" : [ "asc", "desc" ],
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "total" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "required" : [ "total", "limit", "offset", "data" ],
- "type" : "object"
- },
- "metabase.tiles.api.legacy-ref" : {
- "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.field",
- "description" : "Form-encoded JSON-encoded legacy MBQL :field ref."
- },
- "metabase.tiles.api.parameters" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters",
- "description" : "Form-encoded JSON-encoded array of parameter maps."
- },
- "metabase.tiles.api.query" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.query",
- "description" : "Form-encoded JSON-encoded MBQL query."
+ "summary" : "GET /api/cache",
+ "tags" : [ "/api/cache" ]
},
- "metabase.timeline.api.timeline.Timeline" : {
- "properties" : {
- "id" : {
- "minimum" : 1,
- "type" : "integer"
+ "put" : {
+ "description" : "Store cache configuration.",
+ "operationId" : "put-api-cache",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "model" : {
+ "enum" : [ "root", "database", "dashboard", "question" ],
+ "type" : "string"
+ },
+ "model_id" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "strategy" : {
+ "$ref" : "#/components/schemas/metabase.cache.api.cache-strategy"
+ }
+ },
+ "required" : [ "model", "model_id", "strategy" ],
+ "type" : "object"
+ }
+ }
}
},
- "required" : [ "id" ],
- "type" : "object"
- },
- "metabase.timeline.api.timeline.include" : {
- "enum" : [ "events" ],
- "type" : "string"
- },
- "metabase.users-rest.api.user-group-membership" : {
- "description" : "Group Membership info of a User.\n In which :is_group_manager is only included if `advanced-permissions` is enabled.",
- "properties" : {
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "is_group_manager" : {
- "description" : "Only relevant if `advanced-permissions` is enabled. If it is, you should always include this key.",
- "type" : "boolean"
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "required" : [ "id" ],
- "type" : "object"
- },
- "metabase.util.cron.CronHour" : {
- "maximum" : 23,
- "minimum" : 0,
- "type" : "integer"
- },
- "metabase.util.cron.CronMinute" : {
- "maximum" : 59,
- "minimum" : 0,
- "type" : "integer"
- },
- "metabase.util.cron.CronScheduleString" : {
- "description" : "value must be a valid Quartz cron schedule string.",
- "minLength" : 1,
- "type" : "string"
- },
- "metabase.util.cron.ScheduleMap" : {
- "description" : "value must be a valid schedule map. See schema in metabase.util.cron for details.",
- "properties" : {
- "schedule_day" : {
+ "summary" : "PUT /api/cache",
+ "tags" : [ "/api/cache" ]
+ }
+ },
+ "/api/cache/invalidate" : {
+ "post" : {
+ "description" : "Invalidate cache entries.\n\n Use it like `/api/cache/invalidate?database=1&dashboard=15` (any number of database/dashboard/question can be\n supplied).\n\n `&include=overrides` controls whenever you want to invalidate cache for a specific cache configuration without\n touching all nested configurations, or you want your invalidation to trickle down to every card.",
+ "operationId" : "post-api-cache-invalidate",
+ "parameters" : [ {
+ "description" : "All cache configuration overrides should invalidate cache too",
+ "in" : "query",
+ "name" : "include",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "const" : "overrides"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "description" : "A list of database ids",
+ "in" : "query",
+ "name" : "database",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "enum" : [ "sun", "mon", "tue", "wed", "thu", "fri", "sat" ],
- "type" : "string"
+ "items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
- },
- "schedule_frame" : {
+ }
+ }, {
+ "description" : "A list of dashboard ids",
+ "in" : "query",
+ "name" : "dashboard",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "enum" : [ "first", "mid", "last" ],
- "type" : "string"
+ "items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
- },
- "schedule_hour" : {
+ }
+ }, {
+ "description" : "A list of question ids",
+ "in" : "query",
+ "name" : "question",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.util.cron.CronHour"
+ "items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "schedule_minute" : {
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/cache/invalidate",
+ "tags" : [ "/api/cache" ]
+ }
+ },
+ "/api/card" : {
+ "get" : {
+ "description" : "Get all the Cards. Option filter param `f` can be used to change the set of Cards that are returned; default is\n `all`, but other options include `mine`, `bookmarked`, `database`, `table`, `using_model`, `using_segment`, and\n `archived`. See corresponding implementation functions above for the specific behavior of each filter\n option. :card_index:",
+ "operationId" : "get-api-card",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "f",
+ "required" : true,
+ "schema" : {
+ "default" : "all",
+ "enum" : [ "archived", "table", "using_model", "bookmarked", "using_segment", "all", "mine", "database" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "model_id",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.util.cron.CronMinute"
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "schedule_type" : {
- "enum" : [ "hourly", "daily", "weekly", "monthly" ],
- "type" : "string"
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "required" : [ "schedule_type" ],
- "type" : "object"
- },
- "metabase.warehouse-schema-rest.api.table.data-authority-write" : {
- "description" : "Schema for writing a valid table data authority.",
- "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ],
- "type" : "string"
- },
- "metabase.warehouse-schema-rest.api.table.data-layers" : {
- "enum" : [ "copper", "bronze", "gold", "silver" ],
- "type" : "string"
- },
- "metabase.warehouse-schema-rest.api.table.data-sources" : {
- "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ],
- "type" : "string"
+ "summary" : "GET /api/card",
+ "tags" : [ "/api/card" ]
},
- "metabase.warehouses-rest.api.available-settings" : {
- "additionalProperties" : {
- "properties" : {
- "enabled" : {
- "type" : "boolean"
- },
- "reasons" : {
- "items" : {
+ "post" : {
+ "description" : "Create a new `Card`. Card `type` can be `question`, `metric`, or `model`.",
+ "operationId" : "post-api-card",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
"properties" : {
- "key" : {
+ "cache_ttl" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "description" : "String must be a valid 21-character NanoID string.",
+ "pattern" : "^[A-Za-z0-9_\\-]{21}$",
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_tab_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "minLength" : 1,
"type" : "string"
},
- "message" : {
- "anyOf" : [ {
+ "entity_id" : {
+ "oneOf" : [ {
+ "minLength" : 1,
"type" : "string"
- }, { } ]
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "enum" : [ "error", "warning" ],
+ "name" : {
+ "minLength" : 1,
"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"
+ } ]
+ },
+ "result_metadata" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.card-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
}
},
- "required" : [ "key", "type", "message" ],
+ "required" : [ "name", "dataset_query", "display", "visualization_settings" ],
"type" : "object"
- },
- "type" : "array"
+ }
}
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "required" : [ "enabled" ],
- "type" : "object"
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
},
- "type" : "object"
- },
- "metabase.xrays.api.automagic-dashboards.base-64-encoded-json" : {
- "description" : "form-encoded base-64-encoded JSON"
- },
- "metabase.xrays.api.automagic-dashboards.entity-id-or-query" : {
- "description" : "One of these:\n\n * A non-empty string with an Entity ID (including `card__<id>`-encoded Card IDs)\n\n * a form-encoded base-64-encoded JSON-encoded MBQL query\n\n * The name of a transform\n\n (Effectively since the names of transforms are unconstrained this parameter is allowed to be any form-encoded\n string.)",
- "minLength" : 1,
- "type" : "string"
- },
- "metabot.reaction.redirect" : {
- "properties" : {
- "type" : {
- "const" : "metabot.reaction/redirect"
+ "summary" : "POST /api/card",
+ "tags" : [ "/api/card" ]
+ }
+ },
+ "/api/card/collections" : {
+ "post" : {
+ "description" : "Bulk update endpoint for Card Collections. Move a set of `Cards` with `card_ids` into a `Collection` with\n `collection_id`, or remove them from any Collections by passing a `null` `collection_id`.",
+ "operationId" : "post-api-card-collections",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "card_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "card_ids" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
},
- "url" : {
- "type" : "string"
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "required" : [ "type", "url" ],
- "type" : "object"
+ "summary" : "POST /api/card/collections",
+ "tags" : [ "/api/card" ]
}
- }
- },
- "info" : {
- "title" : "Metabase API"
- },
- "openapi" : "3.1.0",
- "paths" : {
- "/api/action/" : {
+ },
+ "/api/card/embeddable" : {
"get" : {
- "description" : "Returns actions that can be used for QueryActions. By default lists all viewable actions. Pass optional\n `?model-id=<model-id>` to limit to actions on a particular model.",
- "parameters" : [ {
- "in" : "query",
- "name" : "model-id",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }, {
- "type" : "null"
- } ]
- }
- } ],
+ "description" : "Fetch a list of Cards where `enable_embedding` is `true`. The cards can be embedded using the embedding endpoints\n and a signed JWT.",
+ "operationId" : "get-api-card-embeddable",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.action"
- },
- "type" : "array"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -12877,30 +18837,44 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/action/",
- "tags" : [ "/api/action" ]
- },
+ "summary" : "GET /api/card/embeddable",
+ "tags" : [ "/api/card" ]
+ }
+ },
+ "/api/card/pivot/{card-id}/query" : {
"post" : {
- "description" : "Create a new action.",
- "parameters" : [ ],
+ "description" : "Run the query associated with a Card.",
+ "operationId" : "post-api-card-pivot-card-id-query",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.actions.schema..action.for-insert"
+ "properties" : {
+ "ignore_cache" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
}
}
}
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.action"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -12910,26 +18884,17 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/action/",
- "tags" : [ "/api/action" ]
+ "summary" : "POST /api/card/pivot/{card-id}/query",
+ "tags" : [ "/api/card" ]
}
},
- "/api/action/public" : {
+ "/api/card/public" : {
"get" : {
- "description" : "Fetch a list of Actions with public UUIDs. These actions are publicly-accessible *if* public sharing is enabled.",
+ "description" : "Fetch a list of Cards with public UUIDs. These cards are publicly-accessible *if* public sharing is enabled.",
+ "operationId" : "get-api-card-public",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.action"
- },
- "type" : "array"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -12939,22 +18904,38 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/action/public",
- "tags" : [ "/api/action" ]
+ "summary" : "GET /api/card/public",
+ "tags" : [ "/api/card" ]
}
},
- "/api/action/{action-id}" : {
- "delete" : {
- "description" : "Delete an Action.",
+ "/api/card/{card-id}/params/{param-key}/search/{query}" : {
+ "get" : {
+ "description" : "Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`.\n\n ;; fetch values for Card 1 parameter 'abc' that contain 'Orange';\n GET /api/queries/1/params/abc/search/Orange\n\n Currently limited to first 1000 results.",
+ "operationId" : "get-api-card-card-id-params-param-key-search-query",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "action-id",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
+ }
+ }, {
+ "in" : "path",
+ "name" : "query",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -12967,30 +18948,33 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/action/{action-id}",
- "tags" : [ "/api/action" ]
- },
+ "summary" : "GET /api/card/{card-id}/params/{param-key}/search/{query}",
+ "tags" : [ "/api/card" ]
+ }
+ },
+ "/api/card/{card-id}/params/{param-key}/values" : {
"get" : {
- "description" : "Fetch an Action.",
+ "description" : "Fetch possible values of the parameter whose ID is `:param-key`.\n\n ;; fetch values for Card 1 parameter 'abc' that are possible\n GET /api/queries/1/params/abc/values",
+ "operationId" : "get-api-card-card-id-params-param-key-values",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "action-id",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
+ }
} ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.action"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -13000,29 +18984,49 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/action/{action-id}",
- "tags" : [ "/api/action" ]
+ "summary" : "GET /api/card/{card-id}/params/{param-key}/values",
+ "tags" : [ "/api/card" ]
}
},
- "/api/action/{action-id}/execute" : {
- "get" : {
- "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",
+ "/api/card/{card-id}/public_link" : {
+ "delete" : {
+ "description" : "Delete the publicly-accessible link to this Card.",
+ "operationId" : "delete-api-card-card-id-public_link",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "action-id",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- }, {
- "description" : "value must be a valid JSON string.",
- "in" : "query",
- "name" : "parameters",
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "DELETE /api/card/{card-id}/public_link",
+ "tags" : [ "/api/card" ]
+ },
+ "post" : {
+ "description" : "Generate publicly-accessible links for this Card. Returns UUID to be used in public links. (If this Card has\n already been shared, it will return the existing public link rather than creating a new one.) Public sharing must\n be enabled.",
+ "operationId" : "post-api-card-card-id-public_link",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
"required" : true,
"schema" : {
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -13036,26 +19040,58 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/action/{action-id}/execute",
- "tags" : [ "/api/action" ]
+ "summary" : "POST /api/card/{card-id}/public_link",
+ "tags" : [ "/api/card" ]
}
},
- "/api/action/{id}" : {
- "put" : {
- "description" : "Update an Action.",
+ "/api/card/{card-id}/query" : {
+ "post" : {
+ "description" : "Run the query associated with a Card.",
+ "operationId" : "post-api-card-card-id-query",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "card-id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "description" : "String must be a valid 21-character NanoID string.",
+ "pattern" : "^[A-Za-z0-9_\\-]{21}$",
+ "type" : "string"
+ } ]
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.actions.schema..action.for-update"
+ "properties" : {
+ "collection_preview" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ignore_cache" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "ignore_cache" ],
+ "type" : "object"
}
}
}
@@ -13071,40 +19107,58 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/action/{id}",
- "tags" : [ "/api/action" ]
+ "summary" : "POST /api/card/{card-id}/query",
+ "tags" : [ "/api/card" ]
}
},
- "/api/action/{id}/execute" : {
+ "/api/card/{card-id}/query/{export-format}" : {
"post" : {
- "description" : "Execute the Action.\n\n `parameters` should be the mapped dashboard parameters with values.",
+ "description" : "Run the query associated with a Card, and return its results as a file in the specified format.\n\n `parameters`, `pivot-results?` and `format-rows?` should be passed as application/x-www-form-urlencoded form content\n or json in the body. This is because this endpoint is normally used to power 'Download Results' buttons that use\n HTML `form` actions).",
+ "operationId" : "post-api-card-card-id-query-export-format",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "card-id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "oneOf" : [ {
- "properties" : {
- "parameters" : {
- "oneOf" : [ {
+ "properties" : {
+ "format_rows" : {
+ "default" : false,
+ "type" : "boolean"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "items" : {
"additionalProperties" : { },
"type" : "object"
- }, {
- "type" : "null"
- } ]
- }
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : "object"
- }, {
- "type" : "null"
- } ]
+ "pivot_results" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "format_rows", "pivot_results" ],
+ "type" : "object"
}
}
}
@@ -13120,19 +19174,22 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/action/{id}/execute",
- "tags" : [ "/api/action" ]
+ "summary" : "POST /api/card/{card-id}/query/{export-format}",
+ "tags" : [ "/api/card" ]
}
},
- "/api/action/{id}/public_link" : {
+ "/api/card/{id}" : {
"delete" : {
- "description" : "Delete the publicly-accessible link to this Dashboard.",
+ "description" : "Hard delete a Card. To soft delete, use `PUT /api/queries/:id`",
+ "operationId" : "delete-api-card-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -13146,17 +19203,38 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/action/{id}/public_link",
- "tags" : [ "/api/action" ]
+ "summary" : "DELETE /api/card/{id}",
+ "tags" : [ "/api/card" ]
},
- "post" : {
- "description" : "Generate publicly-accessible links for this Action. Returns UUID to be used in public links. (If this\n Action has already been shared, it will return the existing public link rather than creating a new one.) Public\n sharing must be enabled.",
+ "get" : {
+ "description" : "Get `Card` with ID.\n\n As of v57, returns the MBQL query (`dataset_query`) as MBQL 5; to return the query as MBQL 4 (aka legacy MBQL)\n instead, you can specify `?legacy-mbql=true`.",
+ "operationId" : "get-api-card-id",
"parameters" : [ {
"in" : "path",
"name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.actions.schema.id"
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "description" : "String must be a valid 21-character NanoID string.",
+ "pattern" : "^[A-Za-z0-9_\\-]{21}$",
+ "type" : "string"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "legacy-mbql",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
@@ -13170,14 +19248,202 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/action/{id}/public_link",
- "tags" : [ "/api/action" ]
- }
- },
- "/api/activity/most_recently_viewed_dashboard" : {
- "get" : {
- "description" : "Get the most recently viewed dashboard for the current user. Returns a 204 if the user has not viewed any dashboards\n in the last 24 hours.",
- "parameters" : [ ],
+ "summary" : "GET /api/card/{id}",
+ "tags" : [ "/api/card" ]
+ },
+ "put" : {
+ "description" : "Update a `Card`.",
+ "operationId" : "put-api-card-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "delete_old_dashcards",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "cache_ttl" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_preview" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_tab_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "embedding_params" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid embedding params map.",
+ "oneOf" : [ {
+ "additionalProperties" : {
+ "enum" : [ "disabled", "enabled", "locked" ],
+ "type" : "string"
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "embedding_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "enable_embedding" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "result_metadata" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.queries.schema.card-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -13189,14 +19455,24 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/activity/most_recently_viewed_dashboard",
- "tags" : [ "/api/activity" ]
+ "summary" : "PUT /api/card/{id}",
+ "tags" : [ "/api/card" ]
}
},
- "/api/activity/popular_items" : {
- "get" : {
- "description" : "Get the list of 5 popular things on the instance. Query takes 8 and limits to 5 so that if it finds anything\n archived, deleted, etc it can usually still get 5. ",
- "parameters" : [ ],
+ "/api/card/{id}/copy" : {
+ "post" : {
+ "description" : "Copy a `Card`, with the new name 'Copy of _name_'",
+ "operationId" : "post-api-card-id-copy",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -13208,15 +19484,24 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/activity/popular_items",
- "tags" : [ "/api/activity" ]
+ "summary" : "POST /api/card/{id}/copy",
+ "tags" : [ "/api/card" ]
}
},
- "/api/activity/recent_views" : {
+ "/api/card/{id}/dashboards" : {
"get" : {
- "deprecated" : true,
- "description" : "Get a list of 100 models (cards, models, tables, dashboards, and collections) that the current user has been viewing most\n recently. Return a maximum of 20 model of each, if they've looked at at least 20.",
- "parameters" : [ ],
+ "description" : "Get a list of `{:name ... :id ...}` pairs for all the dashboards this card appears in.",
+ "operationId" : "get-api-card-id-dashboards",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -13228,35 +19513,34 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/activity/recent_views",
- "tags" : [ "/api/activity" ]
+ "summary" : "GET /api/card/{id}/dashboards",
+ "tags" : [ "/api/card" ]
}
},
- "/api/activity/recents" : {
+ "/api/card/{id}/params/{param-key}/remapping" : {
"get" : {
- "description" : "Get a list of recent items the current user has been viewing most recently under the `:recents` key.\n Allows for filtering by context: views or selections",
+ "description" : "Fetch the remapped value for a given value of the parameter with ID `:param-key`.\n\n ;; fetch the remapped value for Card 1 parameter 'abc' for value 100\n GET /api/queries/1/params/abc/remapping?value=100",
+ "operationId" : "get-api-card-id-params-param-key-remapping",
"parameters" : [ {
- "in" : "query",
- "name" : "context",
+ "in" : "path",
+ "name" : "id",
"required" : true,
"schema" : {
- "items" : {
- "enum" : [ "selections", "views" ],
- "type" : "string"
- },
- "type" : "array"
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
}
}, {
"in" : "query",
- "name" : "include_metadata",
+ "name" : "value",
"required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
} ],
"responses" : {
@@ -13270,78 +19554,27 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/activity/recents",
- "tags" : [ "/api/activity" ]
- },
- "post" : {
- "description" : "Adds a model to the list of recently selected items.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "context" : {
- "enum" : [ "selection" ],
- "type" : "string"
- },
- "model" : {
- "enum" : [ "card", "dataset", "metric", "dashboard", "table", "collection", "document" ],
- "type" : "string"
- },
- "model_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "model", "model_id", "context" ],
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/activity/recents",
- "tags" : [ "/api/activity" ]
+ "summary" : "GET /api/card/{id}/params/{param-key}/remapping",
+ "tags" : [ "/api/card" ]
}
},
- "/api/alert/" : {
+ "/api/card/{id}/query_metadata" : {
"get" : {
- "description" : "Fetch alerts which the current user has created or will receive, or all alerts if the user is an admin.\n The optional `user_id` will return alerts created by the corresponding user, but is ignored for non-admin users.",
+ "description" : "Get all of the required query metadata for a card.",
+ "operationId" : "get-api-card-id-query_metadata",
"parameters" : [ {
- "in" : "query",
- "name" : "archived",
+ "in" : "path",
+ "name" : "id",
"required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "user_id",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
+ "anyOf" : [ {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
"type" : "integer"
}, {
- "type" : "null"
+ "description" : "String must be a valid 21-character NanoID string.",
+ "pattern" : "^[A-Za-z0-9_\\-]{21}$",
+ "type" : "string"
} ]
}
} ],
@@ -13356,21 +19589,54 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/alert/",
- "tags" : [ "/api/alert" ]
+ "summary" : "GET /api/card/{id}/query_metadata",
+ "tags" : [ "/api/card" ]
}
},
- "/api/alert/{id}" : {
+ "/api/card/{id}/series" : {
"get" : {
- "description" : "Fetch an alert by ID",
+ "description" : "Fetches a list of compatible series with the card with id `card_id`.\n\n - `last_cursor` with value is the id of the last card from the previous page to fetch the next page.\n - `query` to search card by name.\n - `exclude_ids` to filter out a list of card ids",
+ "operationId" : "get-api-card-id-series",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "id",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "last_cursor",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "query",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "exclude_ids",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
@@ -13384,23 +19650,35 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/alert/{id}",
- "tags" : [ "/api/alert" ]
+ "summary" : "GET /api/card/{id}/series",
+ "tags" : [ "/api/card" ]
}
},
- "/api/alert/{id}/subscription" : {
- "delete" : {
- "description" : "For users to unsubscribe themselves from the given alert.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "/api/cards/dashboards" : {
+ "post" : {
+ "description" : "Get the dashboards that multiple cards appear in. The response is a sequence of maps, each of which has a `card_id`\n and `dashboards`. `dashboard` may include an `:error` key, either `:unreadable-dashboard` or\n `:unwritable-dashboard`. In the case of an `unreadable-dashboard` the dashboard details (name, ID) will NOT be\n present.",
+ "operationId" : "post-api-cards-dashboards",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "card_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "card_ids" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -13412,14 +19690,53 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/alert/{id}/subscription",
- "tags" : [ "/api/alert" ]
+ "summary" : "POST /api/cards/dashboards",
+ "tags" : [ "/api/cards" ]
}
},
- "/api/analytics/anonymous-stats" : {
- "get" : {
- "description" : "Anonymous usage stats. Endpoint for testing, and eventually exposing this to instance admins to let them see\n what is being phoned home.",
+ "/api/cards/move" : {
+ "post" : {
+ "description" : "Moves a number of Cards to a single collection or dashboard.\n\n For now, just either succeed or fail as a batch - we can think more about error handling later down the road.",
+ "operationId" : "post-api-cards-move",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "card_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "card_ids" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -13431,14 +19748,34 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/analytics/anonymous-stats",
- "tags" : [ "/api/analytics" ]
+ "summary" : "POST /api/cards/move",
+ "tags" : [ "/api/cards" ]
}
},
- "/api/api-key/" : {
+ "/api/channel" : {
"get" : {
- "description" : "Get a list of API keys with the default scope. Non-paginated.",
+ "description" : "Get all channels",
+ "operationId" : "get-api-channel",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "include_inactive" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -13450,26 +19787,47 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/api-key/",
- "tags" : [ "/api/api-key" ]
+ "summary" : "GET /api/channel",
+ "tags" : [ "/api/channel" ]
},
"post" : {
- "description" : "Create a new API key (and an associated `User`) with the provided name and group ID.",
+ "description" : "Create a channel",
+ "operationId" : "post-api-channel",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "group_id" : {
- "$ref" : "#/components/schemas/metabase.api-keys.schema.id"
+ "active" : {
+ "default" : true,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "properties" : { },
+ "type" : "object"
},
"name" : {
"minLength" : 1,
"type" : "string"
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
}
},
- "required" : [ "group_id", "name" ],
+ "required" : [ "name", "type", "details" ],
"type" : "object"
}
}
@@ -13486,14 +19844,34 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/api-key/",
- "tags" : [ "/api/api-key" ]
+ "summary" : "POST /api/channel",
+ "tags" : [ "/api/channel" ]
}
},
- "/api/api-key/count" : {
- "get" : {
- "description" : "Get the count of API keys in the DB with the default scope.",
+ "/api/channel/test" : {
+ "post" : {
+ "description" : "Test a channel connection",
+ "operationId" : "post-api-channel-test",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "details" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
+ }
+ },
+ "required" : [ "type", "details" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -13505,19 +19883,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/api-key/count",
- "tags" : [ "/api/api-key" ]
+ "summary" : "POST /api/channel/test",
+ "tags" : [ "/api/channel" ]
}
},
- "/api/api-key/{id}" : {
- "delete" : {
- "description" : "Delete an ApiKey",
+ "/api/channel/{id}" : {
+ "get" : {
+ "description" : "Get a channel",
+ "operationId" : "get-api-channel-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.api-keys.schema.id"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -13531,11 +19912,12 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/api-key/{id}",
- "tags" : [ "/api/api-key" ]
+ "summary" : "GET /api/channel/{id}",
+ "tags" : [ "/api/channel" ]
},
"put" : {
- "description" : "Update an API key by changing its group and/or its name",
+ "description" : "Update a channel",
+ "operationId" : "put-api-channel-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -13551,18 +19933,40 @@
"application/json" : {
"schema" : {
"properties" : {
- "group_id" : {
+ "active" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
}, {
"type" : "null"
} ]
},
"name" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.api-keys.schema.name"
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "description" : "Must be a namespaced channel. E.g: channel/http"
}, {
"type" : "null"
} ]
@@ -13584,45 +19988,35 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/api-key/{id}",
- "tags" : [ "/api/api-key" ]
+ "summary" : "PUT /api/channel/{id}",
+ "tags" : [ "/api/channel" ]
}
},
- "/api/api-key/{id}/regenerate" : {
- "put" : {
- "description" : "Regenerate an API Key",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.api-keys.schema.id"
+ "/api/cloud-migration" : {
+ "get" : {
+ "description" : "Get the latest cloud migration, if any.",
+ "operationId" : "get-api-cloud-migration",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- } ],
+ },
+ "summary" : "GET /api/cloud-migration",
+ "tags" : [ "/api/cloud-migration" ]
+ },
+ "post" : {
+ "description" : "Initiate a new cloud migration.",
+ "operationId" : "post-api-cloud-migration",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "id" : {
- "$ref" : "#/components/schemas/metabase.api-keys.schema.id"
- },
- "masked_key" : {
- "$ref" : "#/components/schemas/metabase.api-keys.schema..key.masked"
- },
- "prefix" : {
- "$ref" : "#/components/schemas/metabase.api-keys.schema.prefix"
- },
- "unmasked_key" : {
- "$ref" : "#/components/schemas/metabase.api-keys.schema..key.raw"
- }
- },
- "required" : [ "id", "unmasked_key", "masked_key", "prefix" ],
- "type" : "object"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -13632,23 +20026,15 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/api-key/{id}/regenerate",
- "tags" : [ "/api/api-key" ]
+ "summary" : "POST /api/cloud-migration",
+ "tags" : [ "/api/cloud-migration" ]
}
},
- "/api/automagic-dashboards/database/{id}/candidates" : {
- "get" : {
- "description" : "Return a list of candidates for automagic dashboards ordered by interestingness.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "/api/cloud-migration/cancel" : {
+ "put" : {
+ "description" : "Cancel any ongoing cloud migrations, if any.",
+ "operationId" : "put-api-cloud-migration-cancel",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -13660,26 +20046,61 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/database/{id}/candidates",
- "tags" : [ "/api/automagic-dashboards" ]
+ "summary" : "PUT /api/cloud-migration/cancel",
+ "tags" : [ "/api/cloud-migration" ]
}
},
- "/api/automagic-dashboards/model_index/{model-index-id}/primary_key/{pk-id}" : {
+ "/api/collection" : {
"get" : {
- "description" : "Return an automagic dashboard for an entity detail specified by `entity`\n with id `id` and a primary key of `indexed-value`.",
+ "description" : "Fetch a list of all Collections that the current user has read permissions for (`:can_write` is returned as an\n additional property of each Collection so you can tell which of these you have write permissions for.)\n\n By default, this returns non-archived Collections, but instead you can show archived ones by passing\n `?archived=true`.\n\n By default, admin users will see all collections. To hide other user's collections pass in\n `?exclude-other-user-collections=true`.\n\n If personal-only is `true`, then return only personal collections where `personal_owner_id` is not `nil`.",
+ "operationId" : "get-api-collection",
"parameters" : [ {
- "in" : "path",
- "name" : "model-index-id",
+ "in" : "query",
+ "name" : "archived",
"required" : true,
"schema" : {
- "type" : "integer"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "in" : "path",
- "name" : "pk-id",
+ "in" : "query",
+ "name" : "exclude-other-user-collections",
"required" : true,
"schema" : {
- "type" : "integer"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "namespace",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "personal-only",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
@@ -13693,45 +20114,168 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/model_index/{model-index-id}/primary_key/{pk-id}",
- "tags" : [ "/api/automagic-dashboards" ]
+ "summary" : "GET /api/collection",
+ "tags" : [ "/api/collection" ]
+ },
+ "post" : {
+ "description" : "Create a new Collection.",
+ "operationId" : "post-api-collection",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "authority_level" : {
+ "oneOf" : [ {
+ "enum" : [ "official" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "namespace" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parent_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/collection",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/automagic-dashboards/{entity}/{entity-id-or-query}" : {
+ "/api/collection/graph" : {
"get" : {
- "description" : "Return an automagic dashboard for entity `entity` with id `id`.",
+ "description" : "Fetch a graph of all Collection Permissions.",
+ "operationId" : "get-api-collection-graph",
"parameters" : [ {
- "in" : "path",
- "name" : "entity",
- "required" : true,
+ "in" : "query",
+ "name" : "namespace",
+ "required" : false,
"schema" : {
- "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
- "type" : "string"
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
- }, {
- "in" : "path",
- "name" : "entity-id-or-query",
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/collection/graph",
+ "tags" : [ "/api/collection" ]
+ },
+ "put" : {
+ "description" : "Do a batch update of Collections Permissions by passing in a modified graph. Will overwrite parts of the graph that\n are present in the request, and leave the rest unchanged.\n\n If the `force` query parameter is `true`, a `revision` number is not required. The provided graph will be persisted\n as-is, and has the potential to clobber other writes that happened since the last read.\n\n If the `skip_graph` query parameter is `true`, it will only return the current revision, not the entire permissions\n graph.",
+ "operationId" : "put-api-collection-graph",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "force",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "show",
- "required" : false,
+ "name" : "skip-graph",
+ "required" : true,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "anyOf" : [ {
- "const" : "all"
- }, {
- "minimum" : 0,
- "type" : "integer"
- } ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
- } ],
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "groups" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "namespace" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "revision" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "groups" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -13743,49 +20287,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}",
- "tags" : [ "/api/automagic-dashboards" ]
+ "summary" : "PUT /api/collection/graph",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}" : {
+ "/api/collection/root" : {
"get" : {
- "description" : "Return an automagic dashboard analyzing cell in automagic dashboard for entity `entity` defined by query\n `cell-query`.",
+ "description" : "Return the 'Root' Collection object with standard details added",
+ "operationId" : "get-api-collection-root",
"parameters" : [ {
- "in" : "path",
- "name" : "entity",
- "required" : true,
- "schema" : {
- "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "entity-id-or-query",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
- }
- }, {
- "in" : "path",
- "name" : "cell-query",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.base-64-encoded-json"
- }
- }, {
- "description" : "invalid show value",
"in" : "query",
- "name" : "show",
+ "name" : "namespace",
"required" : false,
"schema" : {
"oneOf" : [ {
- "anyOf" : [ {
- "enum" : [ "all" ],
- "type" : "string"
- }, {
- "minimum" : 0,
- "type" : "integer"
- } ]
+ "minLength" : 1,
+ "type" : "string"
}, {
"type" : "null"
} ]
@@ -13802,72 +20319,24 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}",
- "tags" : [ "/api/automagic-dashboards" ]
+ "summary" : "GET /api/collection/root",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
+ "/api/collection/root/dashboard-question-candidates" : {
"get" : {
- "description" : "Return an automagic comparison dashboard for cell in automagic dashboard for entity `entity`\n with id `id` defined by query `cell-query`; compared with entity `comparison-entity` with id\n `comparison-entity-id-or-query.`.",
- "parameters" : [ {
- "in" : "path",
- "name" : "entity",
- "required" : true,
- "schema" : {
- "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "entity-id-or-query",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
- }
- }, {
- "in" : "path",
- "name" : "cell-query",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.base-64-encoded-json"
- }
- }, {
- "description" : "Invalid comparison entity type. Can only be one of \"table\", \"segment\", or \"adhoc\"",
- "in" : "path",
- "name" : "comparison-entity",
- "required" : true,
- "schema" : {
- "enum" : [ "adhoc", "segment", "table" ],
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "comparison-entity-id-or-query",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
- }
- }, {
- "description" : "invalid show value",
- "in" : "query",
- "name" : "show",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "enum" : [ "all" ],
- "type" : "string"
- }, {
- "minimum" : 0,
- "type" : "integer"
- } ]
- }, {
- "type" : "null"
- } ]
- }
- } ],
+ "description" : "Find cards in the root collection that can be moved into dashboards in the root collection. (Same as the above\n endpoint, but for the root collection)",
+ "operationId" : "get-api-collection-root-dashboard-question-candidates",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.collections-rest.api.DashboardQuestionCandidatesResponse"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -13877,146 +20346,139 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
- "tags" : [ "/api/automagic-dashboards" ]
+ "summary" : "GET /api/collection/root/dashboard-question-candidates",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}" : {
+ "/api/collection/root/items" : {
"get" : {
- "description" : "Return an automagic dashboard analyzing cell in question with id `id` defined by query `cell-query` using\n dashboard-template `dashboard-template`.",
+ "description" : "Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collection\n doesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no\n `collection_id` exist. It does, however, have its own set of Permissions.\n\n This endpoint will actually show objects with no `collection_id` for Users that have Root Collection\n permissions, but for people without Root Collection perms, we'll just show the objects that have an effective\n location of `/`.\n\n This endpoint is intended to power a 'Root Folder View' for the Current User, so regardless you'll see all the\n top-level objects you're allowed to access.\n\n By default, this will show the 'normal' Collections namespace; to view a different Collections namespace, such as\n `snippets`, you can pass the `?namespace=` parameter.\n\n By default, library collections are excluded from the results; to include them, pass `?include_library=true`.\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
+ "operationId" : "get-api-collection-root-items",
"parameters" : [ {
- "in" : "path",
- "name" : "entity",
- "required" : true,
+ "in" : "query",
+ "name" : "models",
+ "required" : false,
"schema" : {
- "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
- "type" : "string"
+ "oneOf" : [ {
+ "items" : {
+ "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "transform", "document", "pulse", "metric", "card" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "in" : "path",
- "name" : "entity-id-or-query",
- "required" : true,
+ "in" : "query",
+ "name" : "collection_type",
+ "required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ "enum" : [ "remote-synced" ],
+ "type" : "string"
}
}, {
- "in" : "path",
- "name" : "prefix",
- "required" : true,
- "schema" : { }
- }, {
- "description" : "invalid value for dashboard template name",
- "in" : "path",
- "name" : "dashboard-template",
+ "in" : "query",
+ "name" : "include_can_run_adhoc_query",
"required" : true,
- "schema" : { }
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
}, {
- "in" : "path",
- "name" : "cell-query",
+ "in" : "query",
+ "name" : "archived",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.base-64-encoded-json"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "invalid show value",
"in" : "query",
- "name" : "show",
+ "name" : "namespace",
"required" : false,
"schema" : {
"oneOf" : [ {
- "anyOf" : [ {
- "enum" : [ "all" ],
- "type" : "string"
- }, {
- "minimum" : 0,
- "type" : "integer"
- } ]
+ "minLength" : 1,
+ "type" : "string"
}, {
"type" : "null"
} ]
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}",
- "tags" : [ "/api/automagic-dashboards" ]
- }
- },
- "/api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
- "get" : {
- "description" : "Return an automagic comparison dashboard for cell in automagic dashboard for entity `entity`\n with id `id` defined by query `cell-query` using dashboard-template `dashboard-template`; compared with entity\n `comparison-entity` with id `comparison-entity-id-or-query.`.",
- "parameters" : [ {
- "in" : "path",
- "name" : "entity",
+ }, {
+ "in" : "query",
+ "name" : "include_library",
"required" : true,
"schema" : {
- "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
- "type" : "string"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "in" : "path",
- "name" : "entity-id-or-query",
- "required" : true,
+ "in" : "query",
+ "name" : "pinned_state",
+ "required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ "oneOf" : [ {
+ "enum" : [ "is_not_pinned", "is_pinned", "all" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "in" : "path",
- "name" : "prefix",
- "required" : true,
- "schema" : { }
- }, {
- "description" : "invalid value for dashboard template name",
- "in" : "path",
- "name" : "dashboard-template",
- "required" : true,
- "schema" : { }
- }, {
- "in" : "path",
- "name" : "cell-query",
- "required" : true,
+ "in" : "query",
+ "name" : "sort_column",
+ "required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.base-64-encoded-json"
+ "oneOf" : [ {
+ "enum" : [ "model", "name", "last_edited_by", "last_edited_at", "description" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "Invalid comparison entity type. Can only be one of \"table\", \"segment\", or \"adhoc\"",
- "in" : "path",
- "name" : "comparison-entity",
- "required" : true,
+ "in" : "query",
+ "name" : "sort_direction",
+ "required" : false,
"schema" : {
- "enum" : [ "adhoc", "segment", "table" ],
- "type" : "string"
+ "oneOf" : [ {
+ "enum" : [ "desc", "asc" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "in" : "path",
- "name" : "comparison-entity-id-or-query",
- "required" : true,
+ "in" : "query",
+ "name" : "official_collections_first",
+ "required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "invalid show value",
"in" : "query",
- "name" : "show",
+ "name" : "show_dashboard_questions",
"required" : false,
"schema" : {
"oneOf" : [ {
- "anyOf" : [ {
- "enum" : [ "all" ],
- "type" : "string"
- }, {
- "minimum" : 0,
- "type" : "integer"
- } ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -14033,65 +20495,48 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/cell/{cell-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
- "tags" : [ "/api/automagic-dashboards" ]
+ "summary" : "GET /api/collection/root/items",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/automagic-dashboards/{entity}/{entity-id-or-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
- "get" : {
- "description" : "Return an automagic comparison dashboard for entity `entity` with id `id` compared with entity `comparison-entity`\n with id `comparison-entity-id-or-query.`",
- "parameters" : [ {
- "in" : "path",
- "name" : "entity-id-or-query",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
- }
- }, {
- "in" : "path",
- "name" : "entity",
- "required" : true,
- "schema" : {
- "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
- "type" : "string"
- }
- }, {
- "description" : "Invalid comparison entity type. Can only be one of \"table\", \"segment\", or \"adhoc\"",
- "in" : "path",
- "name" : "comparison-entity",
- "required" : true,
- "schema" : {
- "enum" : [ "adhoc", "segment", "table" ],
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "comparison-entity-id-or-query",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
- }
- }, {
- "description" : "invalid show value",
- "in" : "query",
- "name" : "show",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "enum" : [ "all" ],
- "type" : "string"
- }, {
- "minimum" : 0,
- "type" : "integer"
- } ]
- }, {
- "type" : "null"
- } ]
+ "/api/collection/root/move-dashboard-question-candidates" : {
+ "post" : {
+ "description" : "Move candidate cards to the dashboards they appear in (for the root collection)",
+ "operationId" : "post-api-collection-root-move-dashboard-question-candidates",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "oneOf" : [ {
+ "properties" : {
+ "card_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ }
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.collections-rest.api.MoveDashboardQuestionCandidatesResponse"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -14101,29 +20546,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
- "tags" : [ "/api/automagic-dashboards" ]
+ "summary" : "POST /api/collection/root/move-dashboard-question-candidates",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/automagic-dashboards/{entity}/{entity-id-or-query}/query_metadata" : {
+ "/api/collection/trash" : {
"get" : {
- "description" : "Return all metadata for an automagic dashboard for entity `entity` with id `id`.",
- "parameters" : [ {
- "in" : "path",
- "name" : "entity",
- "required" : true,
- "schema" : {
- "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "entity-id-or-query",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
- }
- } ],
+ "description" : "Fetch the trash collection, as in `/api/collection/:trash-id`",
+ "operationId" : "get-api-collection-trash",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -14135,53 +20566,97 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/query_metadata",
- "tags" : [ "/api/automagic-dashboards" ]
+ "summary" : "GET /api/collection/trash",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}" : {
+ "/api/collection/tree" : {
"get" : {
- "description" : "Return an automagic dashboard for entity `entity` with id `id` using dashboard-template `dashboard-template`.",
+ "description" : "Similar to `GET /`, but returns Collections in a tree structure, e.g.\n\n ```\n [{:name \"A\"\n :below #{:card :dataset}\n :children [{:name \"B\"}\n {:name \"C\"\n :here #{:dataset :card}\n :below #{:dataset :card}\n :children [{:name \"D\"\n :here #{:dataset}\n :children [{:name \"E\"}]}\n {:name \"F\"\n :here #{:card}\n :children [{:name \"G\"}]}]}]}\n {:name \"H\"}]\n ```\n\n The here and below keys indicate the types of items at this particular level of the tree (here) and in its\n subtree (below).\n\n TODO: for historical reasons this returns Saved Questions AS 'card' AND Models as 'dataset'; we should fix this at\n some point in the future.\n\n By default, looks at the `analytics` (if enabled) and regular (`nil`) namespaces. You can optionally pass a\n `namespace` argument, or one or many `namespaces`, to specify the particular collection namespaces you wish to look\n at. For example, `namespaces=analytics&namespaces=` would match the default behavior.\n\n When `shallow` is true, takes an optional `collection-id` and returns only the requested collection (or\n the root, if `collection-id` is `nil`).",
+ "operationId" : "get-api-collection-tree",
"parameters" : [ {
- "in" : "path",
- "name" : "entity",
+ "in" : "query",
+ "name" : "exclude-archived",
"required" : true,
"schema" : {
- "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
- "type" : "string"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "in" : "path",
- "name" : "entity-id-or-query",
+ "in" : "query",
+ "name" : "exclude-other-user-collections",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "in" : "path",
- "name" : "prefix",
+ "in" : "query",
+ "name" : "include-library",
"required" : true,
- "schema" : { }
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
}, {
- "description" : "invalid value for dashboard template name",
- "in" : "path",
- "name" : "dashboard-template",
- "required" : true,
- "schema" : { }
+ "in" : "query",
+ "name" : "namespace",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
}, {
- "description" : "invalid show value",
"in" : "query",
- "name" : "show",
+ "name" : "namespaces",
"required" : false,
"schema" : {
"oneOf" : [ {
- "anyOf" : [ {
- "enum" : [ "all" ],
+ "items" : {
"type" : "string"
- }, {
- "minimum" : 0,
- "type" : "integer"
- } ]
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "shallow",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "collection-id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
@@ -14198,72 +20673,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}",
- "tags" : [ "/api/automagic-dashboards" ]
+ "summary" : "GET /api/collection/tree",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}" : {
- "get" : {
- "description" : "Return an automagic comparison dashboard for entity `entity` with id `id` using dashboard-template\n `dashboard-template`; compared with entity `comparison-entity` with id `comparison-entity-id-or-query.`.",
+ "/api/collection/{id}" : {
+ "delete" : {
+ "description" : "Deletes a collection permanently",
+ "operationId" : "delete-api-collection-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "entity",
- "required" : true,
- "schema" : {
- "enum" : [ "adhoc", "field", "model", "question", "segment", "table", "transform" ],
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "entity-id-or-query",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
- }
- }, {
- "in" : "path",
- "name" : "prefix",
- "required" : true,
- "schema" : { }
- }, {
- "description" : "invalid value for dashboard template name",
- "in" : "path",
- "name" : "dashboard-template",
- "required" : true,
- "schema" : { }
- }, {
- "description" : "Invalid comparison entity type. Can only be one of \"table\", \"segment\", or \"adhoc\"",
- "in" : "path",
- "name" : "comparison-entity",
- "required" : true,
- "schema" : {
- "enum" : [ "adhoc", "segment", "table" ],
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "comparison-entity-id-or-query",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.xrays.api.automagic-dashboards.entity-id-or-query"
- }
- }, {
- "description" : "invalid show value",
- "in" : "query",
- "name" : "show",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "enum" : [ "all" ],
- "type" : "string"
- }, {
- "minimum" : 0,
- "type" : "integer"
- } ]
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -14277,14 +20702,28 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/automagic-dashboards/{entity}/{entity-id-or-query}/rule/{prefix}/{dashboard-template}/compare/{comparison-entity}/{comparison-entity-id-or-query}",
- "tags" : [ "/api/automagic-dashboards" ]
- }
- },
- "/api/bookmark/" : {
+ "summary" : "DELETE /api/collection/{id}",
+ "tags" : [ "/api/collection" ]
+ },
"get" : {
- "description" : "Fetch all bookmarks for the user",
- "parameters" : [ ],
+ "description" : "Fetch a specific Collection with standard details added",
+ "operationId" : "get-api-collection-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "description" : "String must be a valid 21-character NanoID string.",
+ "pattern" : "^[A-Za-z0-9_\\-]{21}$",
+ "type" : "string"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -14296,39 +20735,78 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/bookmark/",
- "tags" : [ "/api/bookmark" ]
- }
- },
- "/api/bookmark/ordering" : {
+ "summary" : "GET /api/collection/{id}",
+ "tags" : [ "/api/collection" ]
+ },
"put" : {
- "description" : "Sets the order of bookmarks for user.",
- "parameters" : [ ],
+ "description" : "Modify an existing Collection, including archiving or unarchiving it, or moving it.",
+ "operationId" : "put-api-collection-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "orderings" : {
- "items" : {
- "properties" : {
- "item_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : {
- "enum" : [ "card", "dashboard", "collection", "document" ],
- "type" : "string"
- }
- },
- "required" : [ "type", "item_id" ],
- "type" : "object"
- },
- "type" : "array"
+ "archived" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "authority_level" : {
+ "oneOf" : [ {
+ "enum" : [ "official" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parent_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "enum" : [ "remote-synced" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "orderings" ],
+ "required" : [ "archived" ],
"type" : "object"
}
}
@@ -14345,22 +20823,15 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/bookmark/ordering",
- "tags" : [ "/api/bookmark" ]
+ "summary" : "PUT /api/collection/{id}",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/bookmark/{model}/{id}" : {
- "delete" : {
- "description" : "Delete a bookmark. Will delete a bookmark assigned to the user making the request by model and id.",
+ "/api/collection/{id}/dashboard-question-candidates" : {
+ "get" : {
+ "description" : "Find cards in this collection that can be moved into dashboards in this collection.\n\n To be eligible, a card must only appear in one dashboard (which is also in this collection), and must not already be a\n dashboard question.",
+ "operationId" : "get-api-collection-id-dashboard-question-candidates",
"parameters" : [ {
- "in" : "path",
- "name" : "model",
- "required" : true,
- "schema" : {
- "enum" : [ "card", "dashboard", "collection", "document" ],
- "type" : "string"
- }
- }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "id",
@@ -14372,6 +20843,13 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.collections-rest.api.DashboardQuestionCandidatesResponse"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -14381,27 +20859,126 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/bookmark/{model}/{id}",
- "tags" : [ "/api/bookmark" ]
- },
- "post" : {
- "description" : "Create a new bookmark for user.",
+ "summary" : "GET /api/collection/{id}/dashboard-question-candidates",
+ "tags" : [ "/api/collection" ]
+ }
+ },
+ "/api/collection/{id}/items" : {
+ "get" : {
+ "description" : "Fetch a specific Collection's items with the following options:\n\n * `models` - only include objects of a specific set of `models`. If unspecified, returns objects of all models\n * `archived` - when `true`, return archived objects *instead* of unarchived ones. Defaults to `false`.\n * `pinned_state` - when `is_pinned`, return pinned objects only.\n when `is_not_pinned`, return non pinned objects only.\n when `all`, return everything. By default returns everything.\n * `include_can_run_adhoc_query` - when this is true hydrates the `can_run_adhoc_query` flag on card models\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
+ "operationId" : "get-api-collection-id-items",
"parameters" : [ {
"in" : "path",
- "name" : "model",
+ "name" : "id",
"required" : true,
"schema" : {
- "enum" : [ "card", "dashboard", "collection", "document" ],
- "type" : "string"
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "description" : "String must be a valid 21-character NanoID string.",
+ "pattern" : "^[A-Za-z0-9_\\-]{21}$",
+ "type" : "string"
+ } ]
}
}, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
+ "in" : "query",
+ "name" : "models",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "items" : {
+ "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "transform", "document", "pulse", "metric", "card" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include_can_run_adhoc_query",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "pinned_state",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "enum" : [ "is_not_pinned", "is_pinned", "all" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort_column",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "enum" : [ "model", "name", "last_edited_by", "last_edited_at", "description" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort_direction",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "enum" : [ "desc", "asc" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "official_collections_first",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "show_dashboard_questions",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
@@ -14415,16 +20992,57 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/bookmark/{model}/{id}",
- "tags" : [ "/api/bookmark" ]
+ "summary" : "GET /api/collection/{id}/items",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/bug-reporting/connection-pool-details" : {
- "get" : {
- "description" : "Returns database connection pool info for the current Metabase instance.",
- "parameters" : [ ],
+ "/api/collection/{id}/move-dashboard-question-candidates" : {
+ "post" : {
+ "description" : "Move candidate cards to the dashboards they appear in.",
+ "operationId" : "post-api-collection-id-move-dashboard-question-candidates",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "oneOf" : [ {
+ "properties" : {
+ "card_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array",
+ "uniqueItems" : true
+ }
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.collections-rest.api.MoveDashboardQuestionCandidatesResponse"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -14434,14 +21052,32 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/bug-reporting/connection-pool-details",
- "tags" : [ "/api/bug-reporting" ]
+ "summary" : "POST /api/collection/{id}/move-dashboard-question-candidates",
+ "tags" : [ "/api/collection" ]
}
},
- "/api/bug-reporting/details" : {
+ "/api/comment" : {
"get" : {
- "description" : "Returns version and system information relevant to filing a bug report against Metabase.",
- "parameters" : [ ],
+ "description" : "Get comments for an entity",
+ "operationId" : "get-api-comment",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "target_type",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "document" ],
+ "type" : "string"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "target_id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -14453,33 +21089,51 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/bug-reporting/details",
- "tags" : [ "/api/bug-reporting" ]
- }
- },
- "/api/cache/" : {
- "delete" : {
- "description" : "Delete cache configurations.",
+ "summary" : "GET /api/comment",
+ "tags" : [ "/api/comment" ]
+ },
+ "post" : {
+ "description" : "Create a new comment",
+ "operationId" : "post-api-comment",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "model" : {
- "enum" : [ "root", "database", "dashboard", "question" ],
+ "child_target_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "content" : {
+ "type" : "object"
+ },
+ "html" : {
"type" : "string"
},
- "model_id" : {
- "items" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
+ "parent_comment_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
"type" : "integer"
- },
- "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "target_type" : {
+ "enum" : [ "document" ],
+ "type" : "string"
}
},
- "required" : [ "model", "model_id" ],
+ "required" : [ "target_type", "target_id", "content", "html" ],
"type" : "object"
}
}
@@ -14496,51 +21150,42 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/cache/",
- "tags" : [ "/api/cache" ]
- },
+ "summary" : "POST /api/comment",
+ "tags" : [ "/api/comment" ]
+ }
+ },
+ "/api/comment/mentions" : {
"get" : {
- "description" : "Return cache configuration.",
- "parameters" : [ {
- "description" : "Type of model",
- "in" : "query",
- "name" : "model",
- "required" : true,
- "schema" : {
- "default" : [ "root" ],
- "items" : {
- "enum" : [ "root", "database", "dashboard", "question" ],
- "type" : "string"
- },
- "type" : "array"
- }
- }, {
- "description" : "Collection id to filter results. Returns everything if not supplied.",
- "in" : "query",
- "name" : "collection",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "description" : "Model id to get configuration for.",
- "in" : "query",
- "name" : "id",
- "required" : false,
+ "description" : "Get a list of entities suitable for mentions. NOTE: only users for now.",
+ "operationId" : "get-api-comment-mentions",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/comment/mentions",
+ "tags" : [ "/api/comment" ]
+ }
+ },
+ "/api/comment/{comment-id}" : {
+ "delete" : {
+ "description" : "Soft delete a comment",
+ "operationId" : "delete-api-comment-comment-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "comment-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -14554,31 +21199,37 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/cache/",
- "tags" : [ "/api/cache" ]
+ "summary" : "DELETE /api/comment/{comment-id}",
+ "tags" : [ "/api/comment" ]
},
"put" : {
- "description" : "Store cache configuration.",
- "parameters" : [ ],
+ "description" : "Update a comment",
+ "operationId" : "put-api-comment-comment-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "comment-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "model" : {
- "enum" : [ "root", "database", "dashboard", "question" ],
- "type" : "string"
+ "content" : {
+ "type" : "object"
},
- "model_id" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
+ "html" : {
+ "type" : "string"
},
- "strategy" : {
- "$ref" : "#/components/schemas/metabase.cache.api.cache-strategy"
+ "is_resolved" : {
+ "type" : "boolean"
}
},
- "required" : [ "model", "model_id", "strategy" ],
"type" : "object"
}
}
@@ -14595,77 +21246,41 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/cache/",
- "tags" : [ "/api/cache" ]
+ "summary" : "PUT /api/comment/{comment-id}",
+ "tags" : [ "/api/comment" ]
}
},
- "/api/cache/invalidate" : {
+ "/api/comment/{comment-id}/reaction" : {
"post" : {
- "description" : "Invalidate cache entries.\n\n Use it like `/api/cache/invalidate?database=1&dashboard=15` (any number of database/dashboard/question can be\n supplied).\n\n `&include=overrides` controls whenever you want to invalidate cache for a specific cache configuration without\n touching all nested configurations, or you want your invalidation to trickle down to every card.",
+ "description" : "Toggle a reaction on a comment",
+ "operationId" : "post-api-comment-comment-id-reaction",
"parameters" : [ {
- "description" : "All cache configuration overrides should invalidate cache too",
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "const" : "overrides"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "description" : "A list of database ids",
- "in" : "query",
- "name" : "database",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "description" : "A list of dashboard ids",
- "in" : "query",
- "name" : "dashboard",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "description" : "A list of question ids",
- "in" : "query",
- "name" : "question",
- "required" : false,
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "comment-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "emoji" : {
+ "maxLength" : 10,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "emoji" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -14677,31 +21292,23 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/cache/invalidate",
- "tags" : [ "/api/cache" ]
+ "summary" : "POST /api/comment/{comment-id}/reaction",
+ "tags" : [ "/api/comment" ]
}
},
- "/api/card/" : {
+ "/api/dashboard" : {
"get" : {
- "description" : "Get all the Cards. Option filter param `f` can be used to change the set of Cards that are returned; default is\n `all`, but other options include `mine`, `bookmarked`, `database`, `table`, `using_model`, `using_segment`, and\n `archived`. See corresponding implementation functions above for the specific behavior of each filter\n option. :card_index:",
+ "deprecated" : true,
+ "description" : "This endpoint is currently unused by the Metabase frontend and may be out of date with the rest of the application.\n It only exists for backwards compatibility and may be removed in the future.\n\n Get `Dashboards`. With filter option `f` (default `all`), restrict results as follows:\n * `all` - Return all Dashboards.\n * `mine` - Return Dashboards created by the current user.\n * `archived` - Return Dashboards that have been archived. (By default, these are *excluded*.)",
+ "operationId" : "get-api-dashboard",
"parameters" : [ {
"in" : "query",
"name" : "f",
- "required" : true,
- "schema" : {
- "default" : "all",
- "enum" : [ "archived", "table", "using_model", "bookmarked", "using_segment", "all", "mine", "database" ],
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "model_id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "enum" : [ "all", "mine", "archived" ],
+ "type" : "string"
}, {
"type" : "null"
} ]
@@ -14718,11 +21325,12 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/",
- "tags" : [ "/api/card" ]
+ "summary" : "GET /api/dashboard",
+ "tags" : [ "/api/dashboard" ]
},
"post" : {
- "description" : "Create a new `Card`. Card `type` can be `question`, `metric`, or `model`.",
+ "description" : "Create a new Dashboard.",
+ "operationId" : "post-api-dashboard",
"parameters" : [ ],
"requestBody" : {
"content" : {
@@ -14739,30 +21347,6 @@
} ]
},
"collection_id" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "description" : "String must be a valid 21-character NanoID string.",
- "pattern" : "^[A-Za-z0-9_\\-]{21}$",
- "type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "dashboard_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
@@ -14771,7 +21355,7 @@
"type" : "null"
} ]
},
- "dashboard_tab_id" : {
+ "collection_position" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
@@ -14780,26 +21364,8 @@
"type" : "null"
} ]
},
- "dataset_query" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
"description" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display" : {
- "minLength" : 1,
- "type" : "string"
- },
- "entity_id" : {
- "oneOf" : [ {
- "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
@@ -14809,41 +21375,15 @@
"minLength" : 1,
"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"
} ]
- },
- "result_metadata" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.card-type"
- }, {
- "type" : "null"
- } ]
- },
- "visualization_settings" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
}
},
- "required" : [ "name", "dataset_query", "display", "visualization_settings" ],
+ "required" : [ "name" ],
"type" : "object"
}
}
@@ -14860,43 +21400,15 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/card/",
- "tags" : [ "/api/card" ]
+ "summary" : "POST /api/dashboard",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/collections" : {
- "post" : {
- "description" : "Bulk update endpoint for Card Collections. Move a set of `Cards` with `card_ids` into a `Collection` with\n `collection_id`, or remove them from any Collections by passing a `null` `collection_id`.",
+ "/api/dashboard/embeddable" : {
+ "get" : {
+ "description" : "Fetch a list of Dashboards where `enable_embedding` is `true`. The dashboards can be embedded using the embedding\n endpoints and a signed JWT.",
+ "operationId" : "get-api-dashboard-embeddable",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "card_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "card_ids" ],
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -14908,14 +21420,39 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/card/collections",
- "tags" : [ "/api/card" ]
+ "summary" : "GET /api/dashboard/embeddable",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/embeddable" : {
+ "/api/dashboard/params/valid-filter-fields" : {
"get" : {
- "description" : "Fetch a list of Cards where `enable_embedding` is `true`. The cards can be embedded using the embedding endpoints\n and a signed JWT.",
- "parameters" : [ ],
+ "description" : "Utility endpoint for powering Dashboard UI. Given some set of `filtered` Field IDs (presumably Fields used in\n parameters) and a set of `filtering` Field IDs that will be used to restrict values of `filtered` Fields, for each\n `filtered` Field ID return the subset of `filtering` Field IDs that would actually be used in a chain filter query\n with these Fields.\n\n e.g. in a chain filter query like\n\n GET /api/dashboard/10/params/PARAM_1/values?PARAM_2=100\n\n Assume `PARAM_1` maps to Field 1 and `PARAM_2` maps to Fields 2 and 3. The underlying MBQL query may or may not\n filter against Fields 2 and 3, depending on whether an FK relationship that lets us create a join against Field 1\n can be found. You can use this endpoint to determine which of those Fields is actually used:\n\n GET /api/dashboard/params/valid-filter-fields?filtered=1&filtering=2&filtering=3\n ;; ->\n {1 [2 3]}\n\n Results are returned as a map of\n\n `filtered` Field ID -> subset of `filtering` Field IDs that would be used in chain filter query",
+ "operationId" : "get-api-dashboard-params-valid-filter-fields",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "filtered",
+ "required" : true,
+ "schema" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "type" : "array"
+ }
+ }, {
+ "in" : "query",
+ "name" : "filtering",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -14927,14 +21464,33 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/embeddable",
- "tags" : [ "/api/card" ]
+ "summary" : "GET /api/dashboard/params/valid-filter-fields",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/pivot/{card-id}/query" : {
+ "/api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {
"post" : {
- "description" : "Run the query associated with a Card.",
+ "description" : "Run a pivot table query for a specific DashCard.",
+ "operationId" : "post-api-dashboard-pivot-dashboard-id-dashcard-dashcard-id-card-card-id-query",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashboard-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "card-id",
@@ -14949,9 +21505,25 @@
"application/json" : {
"schema" : {
"properties" : {
- "ignore_cache" : {
+ "parameters" : {
"oneOf" : [ {
- "type" : "boolean"
+ "items" : {
+ "allOf" : [ {
+ "properties" : {
+ "id" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "id" ],
+ "type" : "object"
+ }, {
+ "additionalProperties" : { },
+ "type" : "object"
+ } ],
+ "description" : "value must be a parameter map with an 'id' key"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
@@ -14973,13 +21545,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/card/pivot/{card-id}/query",
- "tags" : [ "/api/card" ]
+ "summary" : "POST /api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/public" : {
+ "/api/dashboard/public" : {
"get" : {
- "description" : "Fetch a list of Cards with public UUIDs. These cards are publicly-accessible *if* public sharing is enabled.",
+ "description" : "Fetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible *if* public sharing is\n enabled.",
+ "operationId" : "get-api-dashboard-public",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -14992,38 +21565,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/public",
- "tags" : [ "/api/card" ]
+ "summary" : "GET /api/dashboard/public",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/{card-id}/params/{param-key}/search/{query}" : {
- "get" : {
- "description" : "Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`.\n\n ;; fetch values for Card 1 parameter 'abc' that contain 'Orange';\n GET /api/queries/1/params/abc/search/Orange\n\n Currently limited to first 1000 results.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
- }
- }, {
- "in" : "path",
- "name" : "query",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- } ],
+ "/api/dashboard/save" : {
+ "post" : {
+ "description" : "Save a denormalized description of dashboard.",
+ "operationId" : "post-api-dashboard-save",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -15035,29 +21585,23 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/{card-id}/params/{param-key}/search/{query}",
- "tags" : [ "/api/card" ]
+ "summary" : "POST /api/dashboard/save",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/{card-id}/params/{param-key}/values" : {
- "get" : {
- "description" : "Fetch possible values of the parameter whose ID is `:param-key`.\n\n ;; fetch values for Card 1 parameter 'abc' that are possible\n GET /api/queries/1/params/abc/values",
+ "/api/dashboard/save/collection/{parent-collection-id}" : {
+ "post" : {
+ "description" : "Save a denormalized description of dashboard into collection with ID `:parent-collection-id`.",
+ "operationId" : "post-api-dashboard-save-collection-parent-collection-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "card-id",
+ "name" : "parent-collection-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
- }
} ],
"responses" : {
"2XX" : {
@@ -15070,81 +21614,40 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/{card-id}/params/{param-key}/values",
- "tags" : [ "/api/card" ]
+ "summary" : "POST /api/dashboard/save/collection/{parent-collection-id}",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/{card-id}/public_link" : {
- "delete" : {
- "description" : "Delete the publicly-accessible link to this Card.",
+ "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {
+ "post" : {
+ "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it.",
+ "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-card-card-id-query",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "card-id",
+ "name" : "dashboard-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "DELETE /api/card/{card-id}/public_link",
- "tags" : [ "/api/card" ]
- },
- "post" : {
- "description" : "Generate publicly-accessible links for this Card. Returns UUID to be used in public links. (If this Card has\n already been shared, it will return the existing public link rather than creating a new one.) Public sharing must\n be enabled.",
- "parameters" : [ {
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "card-id",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/card/{card-id}/public_link",
- "tags" : [ "/api/card" ]
- }
- },
- "/api/card/{card-id}/query" : {
- "post" : {
- "description" : "Run the query associated with a Card.",
- "parameters" : [ {
+ }, {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "card-id",
"required" : true,
"schema" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "description" : "String must be a valid 21-character NanoID string.",
- "pattern" : "^[A-Za-z0-9_\\-]{21}$",
- "type" : "string"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"requestBody" : {
@@ -15152,28 +21655,38 @@
"application/json" : {
"schema" : {
"properties" : {
- "collection_preview" : {
+ "dashboard_load_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "minLength" : 1,
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "dashboard_id" : {
+ "parameters" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "items" : {
+ "allOf" : [ {
+ "properties" : {
+ "id" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "id" ],
+ "type" : "object"
+ }, {
+ "additionalProperties" : { },
+ "type" : "object"
+ } ],
+ "description" : "value must be a parameter map with an 'id' key"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
- },
- "ignore_cache" : {
- "default" : false,
- "type" : "boolean"
}
},
- "required" : [ "ignore_cache" ],
"type" : "object"
}
}
@@ -15190,14 +21703,33 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/card/{card-id}/query",
- "tags" : [ "/api/card" ]
+ "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/{card-id}/query/{export-format}" : {
+ "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}" : {
"post" : {
- "description" : "Run the query associated with a Card, and return its results as a file in the specified format.\n\n `parameters`, `pivot-results?` and `format-rows?` should be passed as application/x-www-form-urlencoded form content\n or json in the body. This is because this endpoint is normally used to power 'Download Results' buttons that use\n HTML `form` actions).",
+ "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it, and return\n its results as a file in the specified format.\n\n `parameters` should be passed as query parameter encoded as a serialized JSON string (this is because this endpoint\n is normally used to power 'Download Results' buttons that use HTML `form` actions).",
+ "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-card-card-id-query-export-format",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashboard-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "card-id",
@@ -15225,11 +21757,28 @@
},
"parameters" : {
"oneOf" : [ {
- "items" : {
- "additionalProperties" : { },
- "type" : "object"
- },
- "type" : "array"
+ "anyOf" : [ {
+ "items" : {
+ "allOf" : [ {
+ "properties" : {
+ "id" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "id" ],
+ "type" : "object"
+ }, {
+ "additionalProperties" : { },
+ "type" : "object"
+ } ],
+ "description" : "value must be a parameter map with an 'id' key"
+ },
+ "type" : "array"
+ }, {
+ "description" : "value must be a valid JSON string.",
+ "type" : "string"
+ } ]
}, {
"type" : "null"
} ]
@@ -15256,65 +21805,39 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/card/{card-id}/query/{export-format}",
- "tags" : [ "/api/card" ]
+ "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/{id}" : {
- "delete" : {
- "description" : "Hard delete a Card. To soft delete, use `PUT /api/queries/:id`",
+ "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute" : {
+ "get" : {
+ "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",
+ "operationId" : "get-api-dashboard-dashboard-id-dashcard-dashcard-id-execute",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "dashboard-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "DELETE /api/card/{id}",
- "tags" : [ "/api/card" ]
- },
- "get" : {
- "description" : "Get `Card` with ID.\n\n As of v57, returns the MBQL query (`dataset_query`) as MBQL 5; to return the query as MBQL 4 (aka legacy MBQL)\n instead, you can specify `?legacy-mbql=true`.",
- "parameters" : [ {
+ }, {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "description" : "String must be a valid 21-character NanoID string.",
- "pattern" : "^[A-Za-z0-9_\\-]{21}$",
- "type" : "string"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
+ "description" : "value must be a valid JSON string.",
"in" : "query",
- "name" : "legacy-mbql",
+ "name" : "parameters",
"required" : false,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
} ],
"responses" : {
@@ -15328,30 +21851,29 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/{id}",
- "tags" : [ "/api/card" ]
+ "summary" : "GET /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",
+ "tags" : [ "/api/dashboard" ]
},
- "put" : {
- "description" : "Update a `Card`.",
+ "post" : {
+ "description" : "Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.\n\n `parameters` should be the mapped dashboard parameters with values.\n `extra_parameters` should be the extra, user entered parameter values.",
+ "operationId" : "post-api-dashboard-dashboard-id-dashcard-dashcard-id-execute",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "dashboard-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
}, {
- "in" : "query",
- "name" : "delete_old_dashcards",
- "required" : false,
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"requestBody" : {
@@ -15359,159 +21881,9 @@
"application/json" : {
"schema" : {
"properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "cache_ttl" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_preview" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "dashboard_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "dashboard_tab_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "dataset_query" : {
- "oneOf" : [ {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "embedding_params" : {
- "oneOf" : [ {
- "description" : "value must be a valid embedding params map.",
- "oneOf" : [ {
- "additionalProperties" : {
- "enum" : [ "disabled", "enabled", "locked" ],
- "type" : "string"
- },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "embedding_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "enable_embedding" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
- }, {
- "type" : "null"
- } ]
- },
"parameters" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
- }, {
- "type" : "null"
- } ]
- },
- "result_metadata" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.queries.schema.card-type"
- }, {
- "type" : "null"
- } ]
- },
- "visualization_settings" : {
- "oneOf" : [ {
- "description" : "Value must be a map.",
- "properties" : { },
+ "additionalProperties" : { },
"type" : "object"
}, {
"type" : "null"
@@ -15534,17 +21906,18 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/card/{id}",
- "tags" : [ "/api/card" ]
+ "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/{id}/copy" : {
- "post" : {
- "description" : "Copy a `Card`, with the new name 'Copy of _name_'",
+ "/api/dashboard/{dashboard-id}/public_link" : {
+ "delete" : {
+ "description" : "Delete the publicly-accessible link to this Dashboard.",
+ "operationId" : "delete-api-dashboard-dashboard-id-public_link",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "dashboard-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -15562,17 +21935,16 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/card/{id}/copy",
- "tags" : [ "/api/card" ]
- }
- },
- "/api/card/{id}/dashboards" : {
- "get" : {
- "description" : "Get a list of `{:name ... :id ...}` pairs for all the dashboards this card appears in.",
+ "summary" : "DELETE /api/dashboard/{dashboard-id}/public_link",
+ "tags" : [ "/api/dashboard" ]
+ },
+ "post" : {
+ "description" : "Generate publicly-accessible links for this Dashboard. Returns UUID to be used in public links. (If this\n Dashboard has already been shared, it will return the existing public link rather than creating a new one.) Public\n sharing must be enabled.",
+ "operationId" : "post-api-dashboard-dashboard-id-public_link",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "dashboard-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -15590,35 +21962,77 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/{id}/dashboards",
- "tags" : [ "/api/card" ]
+ "summary" : "POST /api/dashboard/{dashboard-id}/public_link",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/{id}/params/{param-key}/remapping" : {
- "get" : {
- "description" : "Fetch the remapped value for a given value of the parameter with ID `:param-key`.\n\n ;; fetch the remapped value for Card 1 parameter 'abc' for value 100\n GET /api/queries/1/params/abc/remapping?value=100",
+ "/api/dashboard/{from-dashboard-id}/copy" : {
+ "post" : {
+ "description" : "Copy a Dashboard.",
+ "operationId" : "post-api-dashboard-from-dashboard-id-copy",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.id"
- }
- }, {
- "in" : "query",
- "name" : "value",
+ "name" : "from-dashboard-id",
"required" : true,
"schema" : {
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_deep_copy" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "is_deep_copy" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -15630,27 +22044,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/{id}/params/{param-key}/remapping",
- "tags" : [ "/api/card" ]
+ "summary" : "POST /api/dashboard/{from-dashboard-id}/copy",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/card/{id}/query_metadata" : {
- "get" : {
- "description" : "Get all of the required query metadata for a card.",
+ "/api/dashboard/{id}" : {
+ "delete" : {
+ "description" : "Hard delete a Dashboard. To soft delete, use `PUT /api/dashboard/:id`\n\n This will remove also any questions/models/segments/metrics that use this database.",
+ "operationId" : "delete-api-dashboard-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "id",
"required" : true,
"schema" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "description" : "String must be a valid 21-character NanoID string.",
- "pattern" : "^[A-Za-z0-9_\\-]{21}$",
- "type" : "string"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -15664,52 +22073,25 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/{id}/query_metadata",
- "tags" : [ "/api/card" ]
- }
- },
- "/api/card/{id}/series" : {
+ "summary" : "DELETE /api/dashboard/{id}",
+ "tags" : [ "/api/dashboard" ]
+ },
"get" : {
- "description" : "Fetches a list of compatible series with the card with id `card_id`.\n\n - `last_cursor` with value is the id of the last card from the previous page to fetch the next page.\n - `query` to search card by name.\n - `exclude_ids` to filter out a list of card ids",
+ "description" : "Get Dashboard with ID.",
+ "operationId" : "get-api-dashboard-id",
"parameters" : [ {
"in" : "path",
"name" : "id",
"required" : true,
"schema" : {
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "last_cursor",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
+ "anyOf" : [ {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
"type" : "integer"
}, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "query",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
+ "description" : "String must be a valid 21-character NanoID string.",
+ "pattern" : "^[A-Za-z0-9_\\-]{21}$",
"type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "exclude_ids",
- "required" : false,
- "schema" : {
- "oneOf" : [ { }, {
- "type" : "null"
} ]
}
} ],
@@ -15724,65 +22106,49 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/card/{id}/series",
- "tags" : [ "/api/card" ]
- }
- },
- "/api/cards/dashboards" : {
- "post" : {
- "description" : "Get the dashboards that multiple cards appear in. The response is a sequence of maps, each of which has a `card_id`\n and `dashboards`. `dashboard` may include an `:error` key, either `:unreadable-dashboard` or\n `:unwritable-dashboard`. In the case of an `unreadable-dashboard` the dashboard details (name, ID) will NOT be\n present.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "card_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
- }
- },
- "required" : [ "card_ids" ],
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "summary" : "GET /api/dashboard/{id}",
+ "tags" : [ "/api/dashboard" ]
+ },
+ "put" : {
+ "description" : "Update a Dashboard, and optionally the `dashcards` and `tabs` of a Dashboard. The request body should be a JSON object with the same\n structure as the response from `GET /api/dashboard/:id`.",
+ "operationId" : "put-api-dashboard-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
- "summary" : "POST /api/cards/dashboards",
- "tags" : [ "/api/cards" ]
- }
- },
- "/api/cards/move" : {
- "post" : {
- "description" : "Moves a number of Cards to a single collection or dashboard.\n\n For now, just either succeed or fail as a batch - we can think more about error handling later down the road.",
- "parameters" : [ ],
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "card_ids" : {
- "items" : {
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "cache_ttl" : {
+ "oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
"type" : "integer"
- },
- "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "caveats" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
"collection_id" : {
"oneOf" : [ {
@@ -15793,7 +22159,7 @@
"type" : "null"
} ]
},
- "dashboard_id" : {
+ "collection_position" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
@@ -15801,83 +22167,110 @@
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "card_ids" ],
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/cards/move",
- "tags" : [ "/api/cards" ]
- }
- },
- "/api/channel/" : {
- "get" : {
- "description" : "Get all channels",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "include_inactive" : {
- "default" : false,
+ },
+ "dashcards" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be seq of maps in which ids are unique",
+ "items" : {
+ "properties" : {
+ "col" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "inline_parameters" : {
+ "oneOf" : [ {
+ "items" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "row" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "series" : {
+ "oneOf" : [ {
+ "items" : {
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "size_x" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "size_y" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "id", "size_x", "size_y", "row", "col" ],
+ "type" : "object"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
- }
- },
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/channel/",
- "tags" : [ "/api/channel" ]
- },
- "post" : {
- "description" : "Create a channel",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "active" : {
- "default" : true,
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "embedding_params" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid embedding params map.",
+ "oneOf" : [ {
+ "additionalProperties" : {
+ "enum" : [ "disabled", "enabled", "locked" ],
+ "type" : "string"
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "embedding_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "enable_embedding" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "name" : {
"oneOf" : [ {
"minLength" : 1,
"type" : "string"
@@ -15885,19 +22278,63 @@
"type" : "null"
} ]
},
- "details" : {
- "properties" : { },
- "type" : "object"
+ "parameters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "minLength" : 1,
- "type" : "string"
+ "points_of_interest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "description" : "Must be a namespaced channel. E.g: channel/http"
+ "position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "show_in_getting_started" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tabs" : {
+ "oneOf" : [ {
+ "description" : "value must be seq of maps in which ids are unique",
+ "items" : {
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "width" : {
+ "enum" : [ "fixed", "full" ],
+ "type" : "string"
}
},
- "required" : [ "name", "type", "details" ],
"type" : "object"
}
}
@@ -15914,28 +22351,114 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/channel/",
- "tags" : [ "/api/channel" ]
+ "summary" : "PUT /api/dashboard/{id}",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/channel/test" : {
- "post" : {
- "description" : "Test a channel connection",
- "parameters" : [ ],
+ "/api/dashboard/{id}/cards" : {
+ "put" : {
+ "description" : "(DEPRECATED -- Use the `PUT /api/dashboard/:id` endpoint instead.)\n Update `Cards` and `Tabs` on a Dashboard. Request body should have the form:\n\n {:cards [{:id ... ; DashboardCard ID\n :size_x ...\n :size_y ...\n :row ...\n :col ...\n :parameter_mappings ...\n :series [{:id 123\n ...}]}\n ...]\n :tabs [{:id ... ; DashboardTab ID\n :name ...}]}",
+ "operationId" : "put-api-dashboard-id-cards",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "details" : {
- "properties" : { },
- "type" : "object"
+ "cards" : {
+ "description" : "value must be seq of maps in which ids are unique",
+ "items" : {
+ "properties" : {
+ "col" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "inline_parameters" : {
+ "oneOf" : [ {
+ "items" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "row" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "series" : {
+ "oneOf" : [ {
+ "items" : {
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "size_x" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "size_y" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "id", "size_x", "size_y", "row", "col" ],
+ "type" : "object"
+ },
+ "type" : "array"
},
- "type" : {
- "description" : "Must be a namespaced channel. E.g: channel/http"
+ "tabs" : {
+ "oneOf" : [ {
+ "description" : "value must be seq of maps in which ids are unique",
+ "items" : {
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "type", "details" ],
+ "required" : [ "cards" ],
"type" : "object"
}
}
@@ -15952,13 +22475,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/channel/test",
- "tags" : [ "/api/channel" ]
+ "summary" : "PUT /api/dashboard/{id}/cards",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/channel/{id}" : {
+ "/api/dashboard/{id}/items" : {
"get" : {
- "description" : "Get a channel",
+ "description" : "Get Dashboard with ID.",
+ "operationId" : "get-api-dashboard-id-items",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -15980,11 +22504,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/channel/{id}",
- "tags" : [ "/api/channel" ]
- },
- "put" : {
- "description" : "Update a channel",
+ "summary" : "GET /api/dashboard/{id}/items",
+ "tags" : [ "/api/dashboard" ]
+ }
+ },
+ "/api/dashboard/{id}/params/{param-key}/remapping" : {
+ "get" : {
+ "description" : "Fetch the remapped value for a given value of the parameter with ID `:param-key`.\n\n ;; fetch the remapped value for Dashboard 1 parameter 'abc' for value 100\n GET /api/dashboard/1/params/abc/remapping?value=100",
+ "operationId" : "get-api-dashboard-id-params-param-key-remapping",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -15994,56 +22521,67 @@
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "details" : {
- "oneOf" : [ {
- "properties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "type" : {
- "oneOf" : [ {
- "description" : "Must be a namespaced channel. E.g: channel/http"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/dashboard/{id}/params/{param-key}/remapping",
+ "tags" : [ "/api/dashboard" ]
+ }
+ },
+ "/api/dashboard/{id}/params/{param-key}/search/{query}" : {
+ "get" : {
+ "description" : "Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`. Optionally restrict\n these values by passing query parameters like `other-parameter=value` e.g.\n\n ;; fetch values for Dashboard 1 parameter 'abc' that contain 'Cam' and are possible when parameter 'def' is set\n ;; to 100\n GET /api/dashboard/1/params/abc/search/Cam?def=100\n\n Currently limited to first 1000 results.",
+ "operationId" : "get-api-dashboard-id-params-param-key-search-query",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "query",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -16055,14 +22593,32 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/channel/{id}",
- "tags" : [ "/api/channel" ]
+ "summary" : "GET /api/dashboard/{id}/params/{param-key}/search/{query}",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/cloud-migration/" : {
+ "/api/dashboard/{id}/params/{param-key}/values" : {
"get" : {
- "description" : "Get the latest cloud migration, if any.",
- "parameters" : [ ],
+ "description" : "Fetch possible values of the parameter whose ID is `:param-key`. If the values come directly from a query, optionally\n restrict these values by passing query parameters like `other-parameter=value` e.g.\n\n ;; fetch values for Dashboard 1 parameter 'abc' that are possible when parameter 'def' is set to 100\n GET /api/dashboard/1/params/abc/values?def=100",
+ "operationId" : "get-api-dashboard-id-params-param-key-values",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -16074,12 +22630,30 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/cloud-migration/",
- "tags" : [ "/api/cloud-migration" ]
- },
- "post" : {
- "description" : "Initiate a new cloud migration.",
- "parameters" : [ ],
+ "summary" : "GET /api/dashboard/{id}/params/{param-key}/values",
+ "tags" : [ "/api/dashboard" ]
+ }
+ },
+ "/api/dashboard/{id}/query_metadata" : {
+ "get" : {
+ "description" : "Get all of the required query metadata for the cards on dashboard.",
+ "operationId" : "get-api-dashboard-id-query_metadata",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "description" : "String must be a valid 21-character NanoID string.",
+ "pattern" : "^[A-Za-z0-9_\\-]{21}$",
+ "type" : "string"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -16091,14 +22665,24 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/cloud-migration/",
- "tags" : [ "/api/cloud-migration" ]
+ "summary" : "GET /api/dashboard/{id}/query_metadata",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/cloud-migration/cancel" : {
- "put" : {
- "description" : "Cancel any ongoing cloud migrations, if any.",
- "parameters" : [ ],
+ "/api/dashboard/{id}/related" : {
+ "get" : {
+ "description" : "Return related entities.",
+ "operationId" : "get-api-dashboard-id-related",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -16110,64 +22694,33 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/cloud-migration/cancel",
- "tags" : [ "/api/cloud-migration" ]
+ "summary" : "GET /api/dashboard/{id}/related",
+ "tags" : [ "/api/dashboard" ]
}
},
- "/api/collection/" : {
- "get" : {
- "description" : "Fetch a list of all Collections that the current user has read permissions for (`:can_write` is returned as an\n additional property of each Collection so you can tell which of these you have write permissions for.)\n\n By default, this returns non-archived Collections, but instead you can show archived ones by passing\n `?archived=true`.\n\n By default, admin users will see all collections. To hide other user's collections pass in\n `?exclude-other-user-collections=true`.\n\n If personal-only is `true`, then return only personal collections where `personal_owner_id` is not `nil`.",
- "parameters" : [ {
- "in" : "query",
- "name" : "archived",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "exclude-other-user-collections",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "namespace",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "personal-only",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "/api/data-studio/table/discard-values" : {
+ "post" : {
+ "description" : "Batch version of /table/:id/discard_values. Takes an abstract table selection as /table/edit does.",
+ "operationId" : "post-api-data-studio-table-discard-values",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.table-selectors"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -16177,56 +22730,86 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/collection/",
- "tags" : [ "/api/collection" ]
- },
+ "summary" : "POST /api/data-studio/table/discard-values",
+ "tags" : [ "/api/data-studio/table" ]
+ }
+ },
+ "/api/data-studio/table/edit" : {
"post" : {
- "description" : "Create a new Collection.",
+ "description" : "Bulk updating tables.",
+ "operationId" : "post-api-data-studio-table-edit",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "additionalProperties" : false,
"properties" : {
- "authority_level" : {
+ "data_authority" : {
"oneOf" : [ {
- "enum" : [ "official" ],
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.data-authorities"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "data_layer" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.data-layers"
}, {
"type" : "null"
} ]
},
- "name" : {
- "minLength" : 1,
- "type" : "string"
+ "data_source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.data-sources"
+ }, {
+ "type" : "null"
+ } ]
},
- "namespace" : {
+ "database_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "entity_type" : {
"oneOf" : [ {
- "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
} ]
},
- "parent_id" : {
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
"type" : "integer"
}, {
"type" : "null"
} ]
+ },
+ "schema_ids" : {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "table_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
}
},
- "required" : [ "name" ],
"type" : "object"
}
}
@@ -16234,6 +22817,15 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "additionalProperties" : false,
+ "properties" : { },
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -16243,101 +22835,33 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/collection/",
- "tags" : [ "/api/collection" ]
+ "summary" : "POST /api/data-studio/table/edit",
+ "tags" : [ "/api/data-studio/table" ]
}
},
- "/api/collection/graph" : {
- "get" : {
- "description" : "Fetch a graph of all Collection Permissions.",
- "parameters" : [ {
- "in" : "query",
- "name" : "namespace",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/collection/graph",
- "tags" : [ "/api/collection" ]
- },
- "put" : {
- "description" : "Do a batch update of Collections Permissions by passing in a modified graph. Will overwrite parts of the graph that\n are present in the request, and leave the rest unchanged.\n\n If the `force` query parameter is `true`, a `revision` number is not required. The provided graph will be persisted\n as-is, and has the potential to clobber other writes that happened since the last read.\n\n If the `skip_graph` query parameter is `true`, it will only return the current revision, not the entire permissions\n graph.",
- "parameters" : [ {
- "in" : "query",
- "name" : "force",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "skip-graph",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- } ],
+ "/api/data-studio/table/rescan-values" : {
+ "post" : {
+ "description" : "Batch version of /table/:id/rescan_values. Takes an abstract table selection as /table/edit does.",
+ "operationId" : "post-api-data-studio-table-rescan-values",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "groups" : {
- "properties" : { },
- "type" : "object"
- },
- "namespace" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "revision" : {
- "oneOf" : [ {
- "description" : "value must be an integer.",
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "groups" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.table-selectors"
}
}
}
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -16347,28 +22871,33 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/collection/graph",
- "tags" : [ "/api/collection" ]
+ "summary" : "POST /api/data-studio/table/rescan-values",
+ "tags" : [ "/api/data-studio/table" ]
}
},
- "/api/collection/root" : {
- "get" : {
- "description" : "Return the 'Root' Collection object with standard details added",
- "parameters" : [ {
- "in" : "query",
- "name" : "namespace",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "/api/data-studio/table/selection" : {
+ "post" : {
+ "description" : "Gets information about selected tables",
+ "operationId" : "post-api-data-studio-table-selection",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.table-selectors"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.bulk-table-selection-info"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -16378,20 +22907,30 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/collection/root",
- "tags" : [ "/api/collection" ]
+ "summary" : "POST /api/data-studio/table/selection",
+ "tags" : [ "/api/data-studio/table" ]
}
},
- "/api/collection/root/dashboard-question-candidates" : {
- "get" : {
- "description" : "Find cards in the root collection that can be moved into dashboards in the root collection. (Same as the above\n endpoint, but for the root collection)",
+ "/api/data-studio/table/sync-schema" : {
+ "post" : {
+ "description" : "Batch version of /table/:id/sync_schema. Takes an abstract table selection as /table/edit does.\n - Currently checks policy before returning (so you might receive a 4xx on e.g. AuthZ policy failure)\n - The sync itself is however, asynchronous. This call may return before all tables synced.",
+ "operationId" : "post-api-data-studio-table-sync-schema",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.data-studio.api.table.table-selectors"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.collections-rest.api.DashboardQuestionCandidatesResponse"
+ "type" : "null"
}
}
},
@@ -16404,39 +22943,29 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/collection/root/dashboard-question-candidates",
- "tags" : [ "/api/collection" ]
+ "summary" : "POST /api/data-studio/table/sync-schema",
+ "tags" : [ "/api/data-studio/table" ]
}
},
- "/api/collection/root/items" : {
+ "/api/database" : {
"get" : {
- "description" : "Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collection\n doesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no\n `collection_id` exist. It does, however, have its own set of Permissions.\n\n This endpoint will actually show objects with no `collection_id` for Users that have Root Collection\n permissions, but for people without Root Collection perms, we'll just show the objects that have an effective\n location of `/`.\n\n This endpoint is intended to power a 'Root Folder View' for the Current User, so regardless you'll see all the\n top-level objects you're allowed to access.\n\n By default, this will show the 'normal' Collections namespace; to view a different Collections namespace, such as\n `snippets`, you can pass the `?namespace=` parameter.\n\n By default, library collections are excluded from the results; to include them, pass `?include_library=true`.\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
+ "description" : "Fetch all `Databases`.\n\n * `include=tables` means we should hydrate the Tables belonging to each DB. Default: `false`.\n\n * `saved` means we should include the saved questions virtual database. Default: `false`.\n\n * `include_editable_data_model` will only include DBs for which the current user has data model editing\n permissions. (If `include=tables`, this also applies to the list of tables in each DB). Should only be used if\n Enterprise Edition code is available the advanced-permissions feature is enabled.\n\n * `exclude_uneditable_details` will only include DBs for which the current user can edit the DB details. Has no\n effect unless Enterprise Edition code is available and the advanced-permissions feature is enabled.\n\n * `include_only_uploadable` will only include DBs into which Metabase can insert new data.\n\n * `can-query` will only include DBs for which the current user has query permissions. Default: `false`.\n\n * `can-write-metadata` will only include DBs for which the current user has data model editing permissions\n for at least one table in the database. Default: `false`.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for\n `:model/Database` in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user\n lacks permission to change the database details.",
+ "operationId" : "get-api-database",
"parameters" : [ {
+ "description" : "include must be either empty or the value 'tables'",
"in" : "query",
- "name" : "models",
+ "name" : "include",
"required" : false,
"schema" : {
"oneOf" : [ {
- "items" : {
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "transform", "document", "pulse", "metric", "card" ],
- "type" : "string"
- },
- "type" : "array"
+ "const" : "tables"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "collection_type",
- "required" : false,
- "schema" : {
- "enum" : [ "remote-synced" ],
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "include_can_run_adhoc_query",
+ "name" : "include_analytics",
"required" : true,
"schema" : {
"default" : false,
@@ -16448,7 +22977,7 @@
}
}, {
"in" : "query",
- "name" : "archived",
+ "name" : "saved",
"required" : true,
"schema" : {
"default" : false,
@@ -16460,19 +22989,7 @@
}
}, {
"in" : "query",
- "name" : "namespace",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include_library",
+ "name" : "include_editable_data_model",
"required" : true,
"schema" : {
"default" : false,
@@ -16484,47 +23001,47 @@
}
}, {
"in" : "query",
- "name" : "pinned_state",
- "required" : false,
+ "name" : "exclude_uneditable_details",
+ "required" : true,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "enum" : [ "is_not_pinned", "is_pinned", "all" ],
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "sort_column",
- "required" : false,
+ "name" : "include_only_uploadable",
+ "required" : true,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "enum" : [ "model", "name", "last_edited_by", "last_edited_at", "description" ],
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "sort_direction",
+ "name" : "router_database_id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "enum" : [ "desc", "asc" ],
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "official_collections_first",
+ "name" : "can-query",
"required" : false,
"schema" : {
"oneOf" : [ {
- "optional" : true,
"type" : "boolean"
}, {
"type" : "null"
@@ -16532,11 +23049,10 @@
}
}, {
"in" : "query",
- "name" : "show_dashboard_questions",
+ "name" : "can-write-metadata",
"required" : false,
"schema" : {
"oneOf" : [ {
- "optional" : true,
"type" : "boolean"
}, {
"type" : "null"
@@ -16554,47 +23070,96 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/collection/root/items",
- "tags" : [ "/api/collection" ]
- }
- },
- "/api/collection/root/move-dashboard-question-candidates" : {
+ "summary" : "GET /api/database",
+ "tags" : [ "/api/database" ]
+ },
"post" : {
- "description" : "Move candidate cards to the dashboards they appear in (for the root collection)",
+ "description" : "Add a new `Database`.",
+ "operationId" : "post-api-database",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "oneOf" : [ {
- "properties" : {
- "card_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array",
- "uniqueItems" : true
- }
+ "properties" : {
+ "auto_run_queries" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.collections-rest.api.MoveDashboardQuestionCandidatesResponse"
- }
+ "cache_ttl" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "connection_source" : {
+ "default" : "admin",
+ "oneOf" : [ {
+ "enum" : [ "admin", "setup" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "engine" : {
+ "description" : "value must be a valid database engine.",
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "is_full_sync" : {
+ "default" : true,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "is_on_demand" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "provider_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedules" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.sync.schedules.ExpandedSchedulesMap"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name", "engine", "details", "is_full_sync", "is_on_demand", "connection_source" ],
+ "type" : "object"
}
- },
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
"description" : "Successful response"
},
"4XX" : {
@@ -16604,13 +23169,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/collection/root/move-dashboard-question-candidates",
- "tags" : [ "/api/collection" ]
+ "summary" : "POST /api/database",
+ "tags" : [ "/api/database" ]
}
},
- "/api/collection/trash" : {
- "get" : {
- "description" : "Fetch the trash collection, as in `/api/collection/:trash-id`",
+ "/api/database/sample_database" : {
+ "post" : {
+ "description" : "Add the sample database as a new `Database`.",
+ "operationId" : "post-api-database-sample_database",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -16623,101 +23189,42 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/collection/trash",
- "tags" : [ "/api/collection" ]
+ "summary" : "POST /api/database/sample_database",
+ "tags" : [ "/api/database" ]
}
},
- "/api/collection/tree" : {
- "get" : {
- "description" : "Similar to `GET /`, but returns Collections in a tree structure, e.g.\n\n ```\n [{:name \"A\"\n :below #{:card :dataset}\n :children [{:name \"B\"}\n {:name \"C\"\n :here #{:dataset :card}\n :below #{:dataset :card}\n :children [{:name \"D\"\n :here #{:dataset}\n :children [{:name \"E\"}]}\n {:name \"F\"\n :here #{:card}\n :children [{:name \"G\"}]}]}]}\n {:name \"H\"}]\n ```\n\n The here and below keys indicate the types of items at this particular level of the tree (here) and in its\n subtree (below).\n\n TODO: for historical reasons this returns Saved Questions AS 'card' AND Models as 'dataset'; we should fix this at\n some point in the future.\n\n By default, looks at the `analytics` (if enabled) and regular (`nil`) namespaces. You can optionally pass a\n `namespace` argument, or one or many `namespaces`, to specify the particular collection namespaces you wish to look\n at. For example, `namespaces=analytics&namespaces=` would match the default behavior.\n\n When `shallow` is true, takes an optional `collection-id` and returns only the requested collection (or\n the root, if `collection-id` is `nil`).",
- "parameters" : [ {
- "in" : "query",
- "name" : "exclude-archived",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "exclude-other-user-collections",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include-library",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "namespace",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "namespaces",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "shallow",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "collection-id",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "/api/database/validate" : {
+ "post" : {
+ "description" : "Validate that we can connect to a database given a set of details.",
+ "operationId" : "post-api-database-validate",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "details" : {
+ "properties" : {
+ "details" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "engine" : {
+ "description" : "value must be a valid database engine.",
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "engine", "details" ],
+ "type" : "object"
+ }
+ },
+ "required" : [ "details" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -16729,13 +23236,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/collection/tree",
- "tags" : [ "/api/collection" ]
+ "summary" : "POST /api/database/validate",
+ "tags" : [ "/api/database" ]
}
},
- "/api/collection/{id}" : {
+ "/api/database/{id}" : {
"delete" : {
- "description" : "Deletes a collection permanently",
+ "description" : "Delete a `Database`.",
+ "operationId" : "delete-api-database-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -16757,26 +23265,47 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/collection/{id}",
- "tags" : [ "/api/collection" ]
+ "summary" : "DELETE /api/database/{id}",
+ "tags" : [ "/api/database" ]
},
"get" : {
- "description" : "Fetch a specific Collection with standard details added",
+ "description" : "Get a single Database with `id`. Optionally pass `?include=tables` or `?include=tables.fields` to include the Tables\n belonging to this database, or the Tables and Fields, respectively. If the requestor has write permissions for the\n DB\n (i.e. is an admin or has data model permissions), then certain inferred secret values will also be included in the\n returned details (see [[metabase.secrets.models.secret/expand-db-details-inferred-secret-values]] for full details).\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.\n In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID\n and tables, with no additional metadata.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for `:model/Database`\n in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user lacks permission to change the\n database details.",
+ "operationId" : "get-api-database-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "id",
"required" : true,
"schema" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "description" : "String must be a valid 21-character NanoID string.",
- "pattern" : "^[A-Za-z0-9_\\-]{21}$",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "include",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "enum" : [ "tables", "tables.fields" ],
"type" : "string"
+ }, {
+ "type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "include_editable_data_model",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "exclude_uneditable_details",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
} ],
"responses" : {
"2XX" : {
@@ -16789,11 +23318,12 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/collection/{id}",
- "tags" : [ "/api/collection" ]
+ "summary" : "GET /api/database/{id}",
+ "tags" : [ "/api/database" ]
},
"put" : {
- "description" : "Modify an existing Collection, including archiving or unarchiving it, or moving it.",
+ "description" : "Update a `Database`.",
+ "operationId" : "put-api-database-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -16809,17 +23339,24 @@
"application/json" : {
"schema" : {
"properties" : {
- "archived" : {
- "default" : false,
+ "auto_run_queries" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
},
- "authority_level" : {
+ "cache_ttl" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "caveats" : {
"oneOf" : [ {
- "enum" : [ "official" ],
"type" : "string"
}, {
"type" : "null"
@@ -16827,6 +23364,23 @@
},
"description" : {
"oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "engine" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid database engine.",
"minLength" : 1,
"type" : "string"
}, {
@@ -16841,25 +23395,53 @@
"type" : "null"
} ]
},
- "parent_id" : {
+ "points_of_interest" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "type" : {
+ "provider_name" : {
"oneOf" : [ {
- "enum" : [ "remote-synced" ],
"type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "refingerprint" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedules" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.sync.schedules.ExpandedSchedulesMap"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "settings" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "write_data_details" : {
+ "oneOf" : [ {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "archived" ],
"type" : "object"
}
}
@@ -16876,13 +23458,14 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/collection/{id}",
- "tags" : [ "/api/collection" ]
+ "summary" : "PUT /api/database/{id}",
+ "tags" : [ "/api/database" ]
}
},
- "/api/collection/{id}/dashboard-question-candidates" : {
+ "/api/database/{id}/autocomplete_suggestions" : {
"get" : {
- "description" : "Find cards in this collection that can be moved into dashboards in this collection.\n\n To be eligible, a card must only appear in one dashboard (which is also in this collection), and must not already be a\n dashboard question.",
+ "description" : "Return a list of autocomplete suggestions for a given `prefix`, or `substring`. Should only specify one, but\n `substring` will have priority if both are present.\n\n This is intended for use with the ACE Editor when the User is typing raw SQL. Suggestions include matching `Tables`\n and `Fields` in this `Database`.\n\n Tables are returned in the format `[table_name \"Table\"]`;\n When Fields have a semantic_type, they are returned in the format `[field_name \"table_name base_type semantic_type\"]`\n When Fields lack a semantic_type, they are returned in the format `[field_name \"table_name base_type\"]`",
+ "operationId" : "get-api-database-id-autocomplete_suggestions",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -16892,16 +23475,33 @@
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "query",
+ "name" : "prefix",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "substring",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.collections-rest.api.DashboardQuestionCandidatesResponse"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -16911,110 +23511,250 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/collection/{id}/dashboard-question-candidates",
- "tags" : [ "/api/collection" ]
+ "summary" : "GET /api/database/{id}/autocomplete_suggestions",
+ "tags" : [ "/api/database" ]
}
},
- "/api/collection/{id}/items" : {
+ "/api/database/{id}/card_autocomplete_suggestions" : {
"get" : {
- "description" : "Fetch a specific Collection's items with the following options:\n\n * `models` - only include objects of a specific set of `models`. If unspecified, returns objects of all models\n * `archived` - when `true`, return archived objects *instead* of unarchived ones. Defaults to `false`.\n * `pinned_state` - when `is_pinned`, return pinned objects only.\n when `is_not_pinned`, return non pinned objects only.\n when `all`, return everything. By default returns everything.\n * `include_can_run_adhoc_query` - when this is true hydrates the `can_run_adhoc_query` flag on card models\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
+ "description" : "Return a list of `Card` autocomplete suggestions for a given `query` in a given `Database`.\n\n This is intended for use with the ACE Editor when the User is typing in a template tag for a `Card`, e.g. {{#...}}.",
+ "operationId" : "get-api-database-id-card_autocomplete_suggestions",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "id",
"required" : true,
"schema" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "description" : "String must be a valid 21-character NanoID string.",
- "pattern" : "^[A-Za-z0-9_\\-]{21}$",
- "type" : "string"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
"in" : "query",
- "name" : "models",
- "required" : false,
+ "name" : "query",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "items" : {
- "enum" : [ "dashboard", "table", "dataset", "no_models", "timeline", "snippet", "collection", "transform", "document", "pulse", "metric", "card" ],
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
+ "minLength" : 1,
+ "type" : "string"
}
}, {
"in" : "query",
- "name" : "archived",
+ "name" : "include_dashboard_questions",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/database/{id}/card_autocomplete_suggestions",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{id}/discard_values" : {
+ "post" : {
+ "description" : "Discards all saved field values for this `Database`.",
+ "operationId" : "post-api-database-id-discard_values",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
"required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "include_can_run_adhoc_query",
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/database/{id}/discard_values",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{id}/dismiss_spinner" : {
+ "post" : {
+ "description" : "Manually set the initial sync status of the `Database` and corresponding\n tables to be `complete` (see #20863)",
+ "operationId" : "post-api-database-id-dismiss_spinner",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
"required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/database/{id}/dismiss_spinner",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{id}/fields" : {
+ "get" : {
+ "description" : "Get a list of all `Fields` in `Database`.",
+ "operationId" : "get-api-database-id-fields",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/database/{id}/fields",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{id}/healthcheck" : {
+ "get" : {
+ "description" : "Reports whether the database can currently connect",
+ "operationId" : "get-api-database-id-healthcheck",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
"in" : "query",
- "name" : "pinned_state",
+ "name" : "connection-type",
"required" : false,
"schema" : {
- "oneOf" : [ {
- "enum" : [ "is_not_pinned", "is_pinned", "all" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "$ref" : "#/components/schemas/metabase.driver.connection.connection-type"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/database/{id}/healthcheck",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{id}/idfields" : {
+ "get" : {
+ "description" : "Get a list of all primary key `Fields` for `Database`.",
+ "operationId" : "get-api-database-id-idfields",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/database/{id}/idfields",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{id}/metadata" : {
+ "get" : {
+ "description" : "Get metadata about a `Database`, including all of its `Tables` and `Fields`. Returns DB, fields, and field values.\n By default only non-hidden tables and fields are returned. Passing include_hidden=true includes them.\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.\n In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID\n and tables, with no additional metadata.",
+ "operationId" : "get-api-database-id-metadata",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
"in" : "query",
- "name" : "sort_column",
- "required" : false,
+ "name" : "include_hidden",
+ "required" : true,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "enum" : [ "model", "name", "last_edited_by", "last_edited_at", "description" ],
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "sort_direction",
- "required" : false,
+ "name" : "include_editable_data_model",
+ "required" : true,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "enum" : [ "desc", "asc" ],
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "official_collections_first",
- "required" : false,
+ "name" : "remove_inactive",
+ "required" : true,
"schema" : {
+ "default" : false,
"oneOf" : [ {
- "optional" : true,
"type" : "boolean"
}, {
"type" : "null"
@@ -17022,7 +23762,7 @@
}
}, {
"in" : "query",
- "name" : "show_dashboard_questions",
+ "name" : "skip_fields",
"required" : true,
"schema" : {
"default" : false,
@@ -17044,13 +23784,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/collection/{id}/items",
- "tags" : [ "/api/collection" ]
+ "summary" : "GET /api/database/{id}/metadata",
+ "tags" : [ "/api/database" ]
}
},
- "/api/collection/{id}/move-dashboard-question-candidates" : {
+ "/api/database/{id}/permission/workspace/check" : {
"post" : {
- "description" : "Move candidate cards to the dashboards they appear in.",
+ "description" : "Check if database's connection has the required permissions to manage workspaces.\n By default it'll return the cached permission check.",
+ "operationId" : "post-api-database-id-permission-workspace-check",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -17060,37 +23801,33 @@
"minimum" : 1,
"type" : "integer"
}
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "oneOf" : [ {
- "properties" : {
- "card_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array",
- "uniqueItems" : true
- }
- },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- }
- }
+ }, {
+ "in" : "path",
+ "name" : "cached",
+ "required" : false,
+ "schema" : {
+ "default" : true,
+ "type" : "boolean"
}
- },
+ } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.collections-rest.api.MoveDashboardQuestionCandidatesResponse"
+ "properties" : {
+ "checked_at" : {
+ "type" : "string"
+ },
+ "error" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "status", "checked_at" ],
+ "type" : "object"
}
}
},
@@ -17103,25 +23840,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/collection/{id}/move-dashboard-question-candidates",
- "tags" : [ "/api/collection" ]
+ "summary" : "POST /api/database/{id}/permission/workspace/check",
+ "tags" : [ "/api/database" ]
}
},
- "/api/comment/" : {
- "get" : {
- "description" : "Get comments for an entity",
+ "/api/database/{id}/rescan_values" : {
+ "post" : {
+ "description" : "Trigger a manual scan of the field values for this `Database`.",
+ "operationId" : "post-api-database-id-rescan_values",
"parameters" : [ {
- "in" : "query",
- "name" : "target_type",
- "required" : true,
- "schema" : {
- "enum" : [ "document" ],
- "type" : "string"
- }
- }, {
"description" : "value must be an integer greater than zero.",
- "in" : "query",
- "name" : "target_id",
+ "in" : "path",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -17139,101 +23869,69 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/comment/",
- "tags" : [ "/api/comment" ]
- },
- "post" : {
- "description" : "Create a new comment",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "child_target_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "content" : {
- "type" : "object"
- },
- "html" : {
- "type" : "string"
- },
- "parent_comment_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "target_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "target_type" : {
- "enum" : [ "document" ],
- "type" : "string"
- }
- },
- "required" : [ "target_type", "target_id", "content", "html" ],
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/comment/",
- "tags" : [ "/api/comment" ]
+ "summary" : "POST /api/database/{id}/rescan_values",
+ "tags" : [ "/api/database" ]
}
},
- "/api/comment/mentions" : {
+ "/api/database/{id}/schema" : {
"get" : {
- "description" : "Get a list of entities suitable for mentions. NOTE: only users for now.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/comment/mentions",
- "tags" : [ "/api/comment" ]
- }
- },
- "/api/comment/{comment-id}" : {
- "delete" : {
- "description" : "Soft delete a comment",
+ "description" : "Return a list of Tables for a Database whose `schema` is `nil` or an empty string.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can query\n - `can-write-metadata=true` - filter to only tables the user can edit metadata for",
+ "operationId" : "get-api-database-id-schema",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "comment-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "query",
+ "name" : "include_hidden",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include_editable_data_model",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "can-query",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "can-write-metadata",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -17246,41 +23944,78 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/comment/{comment-id}",
- "tags" : [ "/api/comment" ]
- },
- "put" : {
- "description" : "Update a comment",
+ "summary" : "GET /api/database/{id}/schema",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{id}/schema/{schema}" : {
+ "get" : {
+ "description" : "Returns a list of Tables for the given Database `id` and `schema`.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can query\n - `can-write-metadata=true` - filter to only tables the user can edit metadata for",
+ "operationId" : "get-api-database-id-schema-schema",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "comment-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "content" : {
- "type" : "object"
- },
- "html" : {
- "type" : "string"
- },
- "is_resolved" : {
- "type" : "boolean"
- }
- },
- "type" : "object"
- }
- }
+ }, {
+ "in" : "path",
+ "name" : "schema",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
}
- },
+ }, {
+ "in" : "query",
+ "name" : "include_hidden",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include_editable_data_model",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "can-query",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "can-write-metadata",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -17292,67 +24027,77 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/comment/{comment-id}",
- "tags" : [ "/api/comment" ]
+ "summary" : "GET /api/database/{id}/schema/{schema}",
+ "tags" : [ "/api/database" ]
}
},
- "/api/comment/{comment-id}/reaction" : {
- "post" : {
- "description" : "Toggle a reaction on a comment",
+ "/api/database/{id}/schemas" : {
+ "get" : {
+ "description" : "Returns a list of all the schemas with tables found for the database `id`. Excludes schemas with no tables.\n\n Optional filters:\n - `can-query=true` - filter to only schemas containing tables the user can query\n - `can-write-metadata=true` - filter to only schemas containing tables the user can edit metadata for",
+ "operationId" : "get-api-database-id-schemas",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "comment-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "emoji" : {
- "maxLength" : 10,
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "emoji" ],
- "type" : "object"
- }
- }
+ }, {
+ "in" : "query",
+ "name" : "include_editable_data_model",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ }, {
+ "in" : "query",
+ "name" : "include_hidden",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "summary" : "POST /api/comment/{comment-id}/reaction",
- "tags" : [ "/api/comment" ]
- }
- },
- "/api/dashboard/" : {
- "get" : {
- "deprecated" : true,
- "description" : "This endpoint is currently unused by the Metabase frontend and may be out of date with the rest of the application.\n It only exists for backwards compatibility and may be removed in the future.\n\n Get `Dashboards`. With filter option `f` (default `all`), restrict results as follows:\n * `all` - Return all Dashboards.\n * `mine` - Return Dashboards created by the current user.\n * `archived` - Return Dashboards that have been archived. (By default, these are *excluded*.)",
- "parameters" : [ {
+ }, {
"in" : "query",
- "name" : "f",
+ "name" : "can-query",
"required" : false,
"schema" : {
"oneOf" : [ {
- "enum" : [ "all", "mine", "archived" ],
- "type" : "string"
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "can-write-metadata",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include_workspace",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -17360,6 +24105,16 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -17369,71 +24124,39 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/",
- "tags" : [ "/api/dashboard" ]
- },
- "post" : {
- "description" : "Create a new Dashboard.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "cache_ttl" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "parameters" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "name" ],
- "type" : "object"
- }
- }
+ "summary" : "GET /api/database/{id}/schemas",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{id}/settings-available" : {
+ "get" : {
+ "description" : "Get all database-local settings and their availability for the given database.",
+ "operationId" : "get-api-database-id-settings-available",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "settings" : {
+ "$ref" : "#/components/schemas/metabase.warehouses-rest.api.available-settings"
+ }
+ },
+ "required" : [ "settings" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -17443,14 +24166,24 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dashboard/",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "GET /api/database/{id}/settings-available",
+ "tags" : [ "/api/database" ]
}
},
- "/api/dashboard/embeddable" : {
- "get" : {
- "description" : "Fetch a list of Dashboards where `enable_embedding` is `true`. The dashboards can be embedded using the embedding\n endpoints and a signed JWT.",
- "parameters" : [ ],
+ "/api/database/{id}/sync_schema" : {
+ "post" : {
+ "description" : "Trigger a manual update of the schema metadata for this `Database`.",
+ "operationId" : "post-api-database-id-sync_schema",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -17462,36 +24195,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/embeddable",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "POST /api/database/{id}/sync_schema",
+ "tags" : [ "/api/database" ]
}
},
- "/api/dashboard/params/valid-filter-fields" : {
+ "/api/database/{id}/syncable_schemas" : {
"get" : {
- "description" : "Utility endpoint for powering Dashboard UI. Given some set of `filtered` Field IDs (presumably Fields used in\n parameters) and a set of `filtering` Field IDs that will be used to restrict values of `filtered` Fields, for each\n `filtered` Field ID return the subset of `filtering` Field IDs that would actually be used in a chain filter query\n with these Fields.\n\n e.g. in a chain filter query like\n\n GET /api/dashboard/10/params/PARAM_1/values?PARAM_2=100\n\n Assume `PARAM_1` maps to Field 1 and `PARAM_2` maps to Fields 2 and 3. The underlying MBQL query may or may not\n filter against Fields 2 and 3, depending on whether an FK relationship that lets us create a join against Field 1\n can be found. You can use this endpoint to determine which of those Fields is actually used:\n\n GET /api/dashboard/params/valid-filter-fields?filtered=1&filtering=2&filtering=3\n ;; ->\n {1 [2 3]}\n\n Results are returned as a map of\n\n `filtered` Field ID -> subset of `filtering` Field IDs that would be used in chain filter query",
+ "description" : "Returns a list of all syncable schemas found for the database `id`.",
+ "operationId" : "get-api-database-id-syncable_schemas",
"parameters" : [ {
- "in" : "query",
- "name" : "filtered",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
"required" : true,
"schema" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "type" : "array"
- }
- }, {
- "in" : "query",
- "name" : "filtering",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -17505,75 +24224,44 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/params/valid-filter-fields",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "GET /api/database/{id}/syncable_schemas",
+ "tags" : [ "/api/database" ]
}
},
- "/api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {
- "post" : {
- "description" : "Run a pivot table query for a specific DashCard.",
+ "/api/database/{id}/usage_info" : {
+ "get" : {
+ "description" : "Get usage info for a database.\n Returns a map with keys are models and values are the number of entities that use this database.",
+ "operationId" : "get-api-database-id-usage_info",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "dashboard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "parameters" : {
- "oneOf" : [ {
- "items" : {
- "allOf" : [ {
- "properties" : {
- "id" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "id" ],
- "type" : "object"
- }, {
- "additionalProperties" : { },
- "type" : "object"
- } ],
- "description" : "value must be a parameter map with an 'id' key"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/database/{id}/usage_info",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{virtual-db}/datasets" : {
+ "get" : {
+ "description" : "Returns a list of all the datasets found for the saved questions virtual database.",
+ "operationId" : "get-api-database-virtual-db-datasets",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -17585,13 +24273,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dashboard/pivot/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "GET /api/database/{virtual-db}/datasets",
+ "tags" : [ "/api/database" ]
}
},
- "/api/dashboard/public" : {
+ "/api/database/{virtual-db}/datasets/{schema}" : {
"get" : {
- "description" : "Fetch a list of Dashboards with public UUIDs. These dashboards are publicly-accessible *if* public sharing is\n enabled.",
+ "description" : "Returns a list of Tables for the datasets virtual database.",
+ "operationId" : "get-api-database-virtual-db-datasets-schema",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -17604,13 +24293,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/public",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "GET /api/database/{virtual-db}/datasets/{schema}",
+ "tags" : [ "/api/database" ]
}
},
- "/api/dashboard/save" : {
- "post" : {
- "description" : "Save a denormalized description of dashboard.",
+ "/api/database/{virtual-db}/metadata" : {
+ "get" : {
+ "description" : "Endpoint that provides metadata for the Saved Questions 'virtual' database. Used for fooling the frontend\n and allowing it to treat the Saved Questions virtual DB just like any other database.",
+ "operationId" : "get-api-database-virtual-db-metadata",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -17623,23 +24313,35 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dashboard/save",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "GET /api/database/{virtual-db}/metadata",
+ "tags" : [ "/api/database" ]
}
},
- "/api/dashboard/save/collection/{parent-collection-id}" : {
- "post" : {
- "description" : "Save a denormalized description of dashboard into collection with ID `:parent-collection-id`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "parent-collection-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "/api/database/{virtual-db}/schema/{schema}" : {
+ "get" : {
+ "description" : "Returns a list of Tables for the saved questions virtual database.",
+ "operationId" : "get-api-database-virtual-db-schema-schema",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- } ],
+ },
+ "summary" : "GET /api/database/{virtual-db}/schema/{schema}",
+ "tags" : [ "/api/database" ]
+ }
+ },
+ "/api/database/{virtual-db}/schemas" : {
+ "get" : {
+ "description" : "Returns a list of all the schemas found for the saved questions virtual database.",
+ "operationId" : "get-api-database-virtual-db-schemas",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -17651,73 +24353,23 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dashboard/save/collection/{parent-collection-id}",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "GET /api/database/{virtual-db}/schemas",
+ "tags" : [ "/api/database" ]
}
},
- "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query" : {
+ "/api/dataset" : {
"post" : {
- "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashboard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "Execute a query and retrieve the results in the usual format. The query will not use the cache.",
+ "operationId" : "post-api-dataset",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "dashboard_load_id" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "parameters" : {
+ "database" : {
"oneOf" : [ {
- "items" : {
- "allOf" : [ {
- "properties" : {
- "id" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "id" ],
- "type" : "object"
- }, {
- "additionalProperties" : { },
- "type" : "object"
- } ],
- "description" : "value must be a parameter map with an 'id' key"
- },
- "type" : "array"
+ "type" : "integer"
}, {
"type" : "null"
} ]
@@ -17730,6 +24382,13 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -17739,91 +24398,35 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "POST /api/dataset",
+ "tags" : [ "/api/dataset" ]
}
},
- "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}" : {
+ "/api/dataset/native" : {
"post" : {
- "description" : "Run the query associated with a Saved Question (`Card`) in the context of a `Dashboard` that includes it, and return\n its results as a file in the specified format.\n\n `parameters` should be passed as query parameter encoded as a serialized JSON string (this is because this endpoint\n is normally used to power 'Download Results' buttons that use HTML `form` actions).",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashboard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "path",
- "name" : "export-format",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
- }
- } ],
+ "description" : "Fetch a native version of an MBQL query.",
+ "operationId" : "post-api-dataset-native",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "format_rows" : {
- "default" : false,
- "type" : "boolean"
+ "database" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
},
- "parameters" : {
+ "pretty" : {
+ "default" : true,
"oneOf" : [ {
- "anyOf" : [ {
- "items" : {
- "allOf" : [ {
- "properties" : {
- "id" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "id" ],
- "type" : "object"
- }, {
- "additionalProperties" : { },
- "type" : "object"
- } ],
- "description" : "value must be a parameter map with an 'id' key"
- },
- "type" : "array"
- }, {
- "description" : "value must be a valid JSON string.",
- "type" : "string"
- } ]
+ "type" : "boolean"
}, {
"type" : "null"
} ]
- },
- "pivot_results" : {
- "default" : false,
- "type" : "boolean"
}
},
- "required" : [ "format_rows", "pivot_results" ],
+ "required" : [ "database", "pretty" ],
"type" : "object"
}
}
@@ -17840,40 +24443,41 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/query/{export-format}",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "POST /api/dataset/native",
+ "tags" : [ "/api/dataset" ]
}
},
- "/api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute" : {
- "get" : {
- "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashboard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be a valid JSON string.",
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
+ "/api/dataset/parameter/remapping" : {
+ "post" : {
+ "description" : "Return the remapped parameter values for cards or dashboards that are being edited.",
+ "operationId" : "post-api-dataset-parameter-remapping",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "field_ids" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
+ },
+ "value" : { }
+ },
+ "required" : [ "parameter", "value" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -17885,28 +24489,21 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",
- "tags" : [ "/api/dashboard" ]
- },
+ "summary" : "POST /api/dataset/parameter/remapping",
+ "tags" : [ "/api/dataset" ]
+ }
+ },
+ "/api/dataset/parameter/search/{query}" : {
"post" : {
- "description" : "Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.\n\n `parameters` should be the mapped dashboard parameters with values.\n `extra_parameters` should be the extra, user entered parameter values.",
+ "description" : "Return parameter values for cards or dashboards that are being edited. Expects a query string at `?query=foo`.",
+ "operationId" : "post-api-dataset-parameter-search-query",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashboard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "dashcard-id",
+ "name" : "query",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "minLength" : 1,
+ "type" : "string"
}
} ],
"requestBody" : {
@@ -17914,15 +24511,21 @@
"application/json" : {
"schema" : {
"properties" : {
- "parameters" : {
+ "field_ids" : {
"oneOf" : [ {
- "additionalProperties" : { },
- "type" : "object"
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
+ },
+ "parameter" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
},
+ "required" : [ "parameter" ],
"type" : "object"
}
}
@@ -17939,23 +24542,40 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dashboard/{dashboard-id}/dashcard/{dashcard-id}/execute",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "POST /api/dataset/parameter/search/{query}",
+ "tags" : [ "/api/dataset" ]
}
},
- "/api/dashboard/{dashboard-id}/public_link" : {
- "delete" : {
- "description" : "Delete the publicly-accessible link to this Dashboard.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashboard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "/api/dataset/parameter/values" : {
+ "post" : {
+ "description" : "Return parameter values for cards or dashboards that are being edited.",
+ "operationId" : "post-api-dataset-parameter-values",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "field_ids" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameter" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
+ }
+ },
+ "required" : [ "parameter" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -17967,23 +24587,41 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/dashboard/{dashboard-id}/public_link",
- "tags" : [ "/api/dashboard" ]
- },
- "post" : {
- "description" : "Generate publicly-accessible links for this Dashboard. Returns UUID to be used in public links. (If this\n Dashboard has already been shared, it will return the existing public link rather than creating a new one.) Public\n sharing must be enabled.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashboard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "summary" : "POST /api/dataset/parameter/values",
+ "tags" : [ "/api/dataset" ]
+ }
+ },
+ "/api/dataset/pivot" : {
+ "post" : {
+ "description" : "Generate a pivoted dataset for an ad-hoc query",
+ "operationId" : "post-api-dataset-pivot",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "database" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "database" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -17993,71 +24631,39 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dashboard/{dashboard-id}/public_link",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "POST /api/dataset/pivot",
+ "tags" : [ "/api/dataset" ]
}
},
- "/api/dashboard/{from-dashboard-id}/copy" : {
+ "/api/dataset/query_metadata" : {
"post" : {
- "description" : "Copy a Dashboard.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "from-dashboard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "Get all of the required query metadata for an ad-hoc query.\n\n You can pass `{:settings {:include-sensitive-fields true}}` in the query to include fields with\n visibility_type :sensitive in the response.",
+ "operationId" : "post-api-dataset-query_metadata",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "is_deep_copy" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "database" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
},
- "name" : {
+ "settings" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
+ "properties" : {
+ "include_sensitive_fields" : {
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "is_deep_copy" ],
+ "required" : [ "database" ],
"type" : "object"
}
}
@@ -18074,25 +24680,60 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dashboard/{from-dashboard-id}/copy",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "POST /api/dataset/query_metadata",
+ "tags" : [ "/api/dataset" ]
}
},
- "/api/dashboard/{id}" : {
- "delete" : {
- "description" : "Hard delete a Dashboard. To soft delete, use `PUT /api/dashboard/:id`\n\n This will remove also any questions/models/segments/metrics that use this database.",
+ "/api/dataset/{export-format}" : {
+ "post" : {
+ "description" : "Execute a query and download the result data as a file in the specified format.",
+ "operationId" : "post-api-dataset-export-format",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "export-format",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "format_rows" : {
+ "default" : false,
+ "type" : "boolean"
+ },
+ "pivot_results" : {
+ "default" : false,
+ "type" : "boolean"
+ },
+ "query" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "visualization_settings" : {
+ "default" : { },
+ "properties" : { },
+ "type" : "object"
+ }
+ },
+ "required" : [ "query", "visualization_settings", "format_rows", "pivot_results" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -18102,27 +24743,15 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/dashboard/{id}",
- "tags" : [ "/api/dashboard" ]
- },
+ "summary" : "POST /api/dataset/{export-format}",
+ "tags" : [ "/api/dataset" ]
+ }
+ },
+ "/api/document" : {
"get" : {
- "description" : "Get Dashboard with ID.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "description" : "String must be a valid 21-character NanoID string.",
- "pattern" : "^[A-Za-z0-9_\\-]{21}$",
- "type" : "string"
- } ]
- }
- } ],
+ "description" : "Gets existing `Documents`.",
+ "operationId" : "get-api-document",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -18134,106 +24763,65 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/{id}",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "GET /api/document",
+ "tags" : [ "/api/document" ]
},
- "put" : {
- "description" : "Update a Dashboard, and optionally the `dashcards` and `tabs` of a Dashboard. The request body should be a JSON object with the same\n structure as the response from `GET /api/dashboard/:id`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "post" : {
+ "description" : "Create a new `Document`.",
+ "operationId" : "post-api-document",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "cache_ttl" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "caveats" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "dashcards" : {
+ "cards" : {
"oneOf" : [ {
- "description" : "value must be seq of maps in which ids are unique",
- "items" : {
+ "additionalProperties" : {
"properties" : {
- "col" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
+ "cache_ttl" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "type" : "integer"
+ "dataset_query" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
},
- "inline_parameters" : {
+ "description" : {
"oneOf" : [ {
- "items" : {
- "minLength" : 1,
- "type" : "string"
- },
- "type" : "array"
+ "minLength" : 1,
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "parameter_mappings" : {
+ "display" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "entity_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
+ "minLength" : 1,
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "row" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
},
- "series" : {
+ "parameter_mappings" : {
"oneOf" : [ {
"items" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
"type" : "object"
},
"type" : "array"
@@ -18241,250 +24829,70 @@
"type" : "null"
} ]
},
- "size_x" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "size_y" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "id", "size_x", "size_y", "row", "col" ],
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "embedding_params" : {
- "oneOf" : [ {
- "description" : "value must be a valid embedding params map.",
- "oneOf" : [ {
- "additionalProperties" : {
- "enum" : [ "disabled", "enabled", "locked" ],
- "type" : "string"
- },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "embedding_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "enable_embedding" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "parameters" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameters"
- }, {
- "type" : "null"
- } ]
- },
- "points_of_interest" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "show_in_getting_started" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "tabs" : {
- "oneOf" : [ {
- "description" : "value must be seq of maps in which ids are unique",
- "items" : {
- "properties" : {
- "id" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "id", "name" ],
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "width" : {
- "enum" : [ "fixed", "full" ],
- "type" : "string"
- }
- },
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "PUT /api/dashboard/{id}",
- "tags" : [ "/api/dashboard" ]
- }
- },
- "/api/dashboard/{id}/cards" : {
- "put" : {
- "description" : "(DEPRECATED -- Use the `PUT /api/dashboard/:id` endpoint instead.)\n Update `Cards` and `Tabs` on a Dashboard. Request body should have the form:\n\n {:cards [{:id ... ; DashboardCard ID\n :size_x ...\n :size_y ...\n :row ...\n :col ...\n :parameter_mappings ...\n :series [{:id 123\n ...}]}\n ...]\n :tabs [{:id ... ; DashboardTab ID\n :name ...}]}",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "cards" : {
- "description" : "value must be seq of maps in which ids are unique",
- "items" : {
- "properties" : {
- "col" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
- },
- "id" : {
- "type" : "integer"
- },
- "inline_parameters" : {
- "oneOf" : [ {
- "items" : {
- "minLength" : 1,
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mappings"
- }, {
- "type" : "null"
- } ]
- },
- "row" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
- },
- "series" : {
- "oneOf" : [ {
- "items" : {
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "size_x" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "size_y" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "id", "size_x", "size_y", "row", "col" ],
- "type" : "object"
- },
- "type" : "array"
- },
- "tabs" : {
- "oneOf" : [ {
- "description" : "value must be seq of maps in which ids are unique",
- "items" : {
- "properties" : {
- "id" : {
- "description" : "value must be an integer.",
- "type" : "integer"
+ "parameters" : {
+ "oneOf" : [ {
+ "items" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
},
- "name" : {
- "minLength" : 1,
- "type" : "string"
+ "result_metadata" : {
+ "oneOf" : [ {
+ "items" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
}
},
- "required" : [ "id", "name" ],
+ "required" : [ "name", "dataset_query", "display", "visualization_settings" ],
"type" : "object"
},
- "type" : "array"
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
+ },
+ "document" : { },
+ "name" : {
+ "maxLength" : 254,
+ "minLength" : 1,
+ "type" : "string"
}
},
- "required" : [ "cards" ],
+ "required" : [ "name", "document" ],
"type" : "object"
}
}
@@ -18501,25 +24909,43 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/dashboard/{id}/cards",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "POST /api/document",
+ "tags" : [ "/api/document" ]
}
},
- "/api/dashboard/{id}/items" : {
+ "/api/document/public" : {
"get" : {
- "description" : "Get Dashboard with ID.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "List all Documents that have public links.\n\n Returns a sequence of Documents that have been publicly shared. Each Document includes its `:id`, `:name`,\n and `:public_uuid`. Documents are only actually accessible via the public endpoint if public sharing is\n currently enabled. Archived Documents are excluded from the results.\n\n This endpoint is used to populate the public links listing in the Admin settings UI.\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.",
+ "operationId" : "get-api-document-public",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "public_uuid" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "id", "public_uuid" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -18529,37 +24955,23 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/{id}/items",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "GET /api/document/public",
+ "tags" : [ "/api/document" ]
}
},
- "/api/dashboard/{id}/params/{param-key}/remapping" : {
- "get" : {
- "description" : "Fetch the remapped value for a given value of the parameter with ID `:param-key`.\n\n ;; fetch the remapped value for Dashboard 1 parameter 'abc' for value 100\n GET /api/dashboard/1/params/abc/remapping?value=100",
+ "/api/document/{document-id}" : {
+ "delete" : {
+ "description" : "Permanently deletes an archived Document.",
+ "operationId" : "delete-api-document-document-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "document-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
} ],
"responses" : {
"2XX" : {
@@ -18572,38 +24984,21 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/{id}/params/{param-key}/remapping",
- "tags" : [ "/api/dashboard" ]
- }
- },
- "/api/dashboard/{id}/params/{param-key}/search/{query}" : {
+ "summary" : "DELETE /api/document/{document-id}",
+ "tags" : [ "/api/document" ]
+ },
"get" : {
- "description" : "Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`. Optionally restrict\n these values by passing query parameters like `other-parameter=value` e.g.\n\n ;; fetch values for Dashboard 1 parameter 'abc' that contain 'Cam' and are possible when parameter 'def' is set\n ;; to 100\n GET /api/dashboard/1/params/abc/search/Cam?def=100\n\n Currently limited to first 1000 results.",
+ "description" : "Returns an existing Document by ID.",
+ "operationId" : "get-api-document-document-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "document-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "query",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
} ],
"responses" : {
"2XX" : {
@@ -18616,31 +25011,156 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/{id}/params/{param-key}/search/{query}",
- "tags" : [ "/api/dashboard" ]
- }
- },
- "/api/dashboard/{id}/params/{param-key}/values" : {
- "get" : {
- "description" : "Fetch possible values of the parameter whose ID is `:param-key`. If the values come directly from a query, optionally\n restrict these values by passing query parameters like `other-parameter=value` e.g.\n\n ;; fetch values for Dashboard 1 parameter 'abc' that are possible when parameter 'def' is set to 100\n GET /api/dashboard/1/params/abc/values?def=100",
+ "summary" : "GET /api/document/{document-id}",
+ "tags" : [ "/api/document" ]
+ },
+ "put" : {
+ "description" : "Updates an existing `Document`.",
+ "operationId" : "put-api-document-document-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "document-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "cards" : {
+ "oneOf" : [ {
+ "additionalProperties" : {
+ "properties" : {
+ "cache_ttl" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "items" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "items" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "result_metadata" : {
+ "oneOf" : [ {
+ "items" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ }
+ },
+ "required" : [ "name", "dataset_query", "display", "visualization_settings" ],
+ "type" : "object"
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "document" : { },
+ "name" : {
+ "maxLength" : 254,
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -18652,57 +25172,77 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/{id}/params/{param-key}/values",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "PUT /api/document/{document-id}",
+ "tags" : [ "/api/document" ]
}
},
- "/api/dashboard/{id}/query_metadata" : {
- "get" : {
- "description" : "Get all of the required query metadata for the cards on dashboard.",
+ "/api/document/{document-id}/card/{card-id}/query/{export-format}" : {
+ "post" : {
+ "description" : "Download query results for a Card embedded in a Document.\n\n Returns query results in the requested format. The user must have read access to the document\n to download results. If the card's query fails, standard query error responses are returned.\n\n Route parameters:\n - document-id: ID of the document containing the card\n - card-id: ID of the card to download results from\n - export-format: Output format (csv, xlsx, json)\n\n Body parameters (snake_case):\n - parameters: Optional query parameters (array of maps or JSON string)\n - format_rows: Whether to apply formatting to results (boolean, default false)\n - pivot_results: Whether to pivot results (boolean, default false)",
+ "operationId" : "post-api-document-document-id-card-card-id-query-export-format",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "document-id",
"required" : true,
"schema" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "description" : "String must be a valid 21-character NanoID string.",
- "pattern" : "^[A-Za-z0-9_\\-]{21}$",
- "type" : "string"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "minimum" : 1,
+ "type" : "integer"
}
- },
- "summary" : "GET /api/dashboard/{id}/query_metadata",
- "tags" : [ "/api/dashboard" ]
- }
- },
- "/api/dashboard/{id}/related" : {
- "get" : {
- "description" : "Return related entities.",
- "parameters" : [ {
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "format_rows" : {
+ "default" : false,
+ "type" : "boolean"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "items" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "description" : "value must be a valid JSON string.",
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "pivot_results" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "format_rows", "pivot_results" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -18714,119 +25254,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/dashboard/{id}/related",
- "tags" : [ "/api/dashboard" ]
+ "summary" : "POST /api/document/{document-id}/card/{card-id}/query/{export-format}",
+ "tags" : [ "/api/document" ]
}
},
- "/api/database/" : {
- "get" : {
- "description" : "Fetch all `Databases`.\n\n * `include=tables` means we should hydrate the Tables belonging to each DB. Default: `false`.\n\n * `saved` means we should include the saved questions virtual database. Default: `false`.\n\n * `include_editable_data_model` will only include DBs for which the current user has data model editing\n permissions. (If `include=tables`, this also applies to the list of tables in each DB). Should only be used if\n Enterprise Edition code is available the advanced-permissions feature is enabled.\n\n * `exclude_uneditable_details` will only include DBs for which the current user can edit the DB details. Has no\n effect unless Enterprise Edition code is available and the advanced-permissions feature is enabled.\n\n * `include_only_uploadable` will only include DBs into which Metabase can insert new data.\n\n * `can-query` will only include DBs for which the current user has query permissions. Default: `false`.\n\n * `can-write-metadata` will only include DBs for which the current user has data model editing permissions\n for at least one table in the database. Default: `false`.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for\n `:model/Database` in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user\n lacks permission to change the database details.",
- "parameters" : [ {
- "description" : "include must be either empty or the value 'tables'",
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "const" : "tables"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include_analytics",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "saved",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include_editable_data_model",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "exclude_uneditable_details",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include_only_uploadable",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "router_database_id",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-query",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-write-metadata",
- "required" : false,
+ "/api/document/{document-id}/public-link" : {
+ "delete" : {
+ "description" : "Remove the public link for a Document.\n\n Deletes the public UUID from the Document, making it no longer accessible via the public sharing endpoint.\n This revokes public access to the Document - the existing public link will no longer work.\n\n Returns a 204 No Content response on success.\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.\n Throws a 404 if the Document doesn't exist, is archived, or doesn't have a public link.",
+ "operationId" : "delete-api-document-document-id-public-link",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "document-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -18840,25 +25283,72 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/",
- "tags" : [ "/api/database" ]
+ "summary" : "DELETE /api/document/{document-id}/public-link",
+ "tags" : [ "/api/document" ]
},
"post" : {
- "description" : "Add a new `Database`.",
- "parameters" : [ ],
+ "description" : "Generate a publicly-accessible UUID for a Document.\n\n Creates a public link that allows viewing the Document without authentication. If the Document already has\n a public UUID, returns the existing one rather than generating a new one. This enables sharing the Document\n via `GET /api/ee/public/document/:uuid`.\n\n Returns a map containing `:uuid` (the public UUID string).\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.",
+ "operationId" : "post-api-document-document-id-public-link",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "document-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "uuid" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ },
+ "required" : [ "uuid" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/document/{document-id}/public-link",
+ "tags" : [ "/api/document" ]
+ }
+ },
+ "/api/document/{from-document-id}/copy" : {
+ "post" : {
+ "description" : "Copy a Document.",
+ "operationId" : "post-api-document-from-document-id-copy",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "from-document-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "auto_run_queries" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "cache_ttl" : {
+ "collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
@@ -18867,61 +25357,24 @@
"type" : "null"
} ]
},
- "connection_source" : {
- "default" : "admin",
- "oneOf" : [ {
- "enum" : [ "admin", "setup" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "details" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "engine" : {
- "description" : "value must be a valid database engine.",
- "minLength" : 1,
- "type" : "string"
- },
- "is_full_sync" : {
- "default" : true,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "is_on_demand" : {
- "default" : false,
+ "collection_position" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "provider_name" : {
"oneOf" : [ {
+ "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
} ]
- },
- "schedules" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.sync.schedules.ExpandedSchedulesMap"
- }, {
- "type" : "null"
- } ]
}
},
- "required" : [ "name", "engine", "details", "is_full_sync", "is_on_demand", "connection_source" ],
"type" : "object"
}
}
@@ -18929,6 +25382,13 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.documents.schema.document"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -18938,14 +25398,41 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/database/",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/document/{from-document-id}/copy",
+ "tags" : [ "/api/document" ]
}
},
- "/api/database/sample_database" : {
+ "/api/ee/action-v2/execute" : {
"post" : {
- "description" : "Add the sample database as a new `Database`.",
+ "description" : "Execute an action with a single input.\n\n Takes:\n - `action` - an identifier or an expression for what we want to execute.\n - `scope` - where the action is being invoked from.\n - `input` - a single map. currently these are typically a database table row pk, or query result.\n - `params` (optional) - a map of values for the parameters taken by the action's mapping.\n\n The `input` and `params` are used by the relevant mapping to calculate a map argument to the underlying action fn.\n If there is no mapping, `params` are simply used as overrides for `input`.\n\n Returns the outputs from the performed action.",
+ "operationId" : "post-api-ee-action-v2-execute",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "action" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"
+ },
+ "input" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "params" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "scope" : {
+ "$ref" : "#/components/schemas/metabase.actions.types..scope.raw"
+ }
+ },
+ "required" : [ "action", "scope" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -18957,36 +25444,40 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/database/sample_database",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/action-v2/execute",
+ "tags" : [ "/api/ee/action-v2" ]
}
},
- "/api/database/validate" : {
+ "/api/ee/action-v2/execute-bulk" : {
"post" : {
- "description" : "Validate that we can connect to a database given a set of details.",
+ "description" : "Execute an action with multiple inputs.\n\n This is typically more efficient than calling execute with each input individually, for example by performing batch\n SQL operations.\n\n Takes:\n - `action` - an identifier or an expression for what we want to execute.\n - `scope` - where the action is being invoked from.\n - `inputs` - a list of maps. currently these are typically a database table row pk, or query result.\n - `params` (optional) - a map of values for the parameters taken by the action's mapping.\n\n The `inputs` and `params` are used by the relevant mapping to calculate a list of args for the underlying action fn.\n If there is no mapping, `params` are simply used as overrides for each map within `inputs`.\n\n Returns the outputs from the performed action.",
+ "operationId" : "post-api-ee-action-v2-execute-bulk",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "details" : {
- "properties" : {
- "details" : {
- "properties" : { },
- "type" : "object"
- },
- "engine" : {
- "description" : "value must be a valid database engine.",
- "minLength" : 1,
- "type" : "string"
- }
+ "action" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"
+ },
+ "inputs" : {
+ "items" : {
+ "properties" : { },
+ "type" : "object"
},
- "required" : [ "engine", "details" ],
+ "minItems" : 1,
+ "type" : "array"
+ },
+ "params" : {
+ "additionalProperties" : { },
"type" : "object"
+ },
+ "scope" : {
+ "$ref" : "#/components/schemas/metabase.actions.types..scope.raw"
}
},
- "required" : [ "details" ],
+ "required" : [ "action", "scope", "inputs" ],
"type" : "object"
}
}
@@ -19003,23 +25494,15 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/database/validate",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/action-v2/execute-bulk",
+ "tags" : [ "/api/ee/action-v2" ]
}
},
- "/api/database/{id}" : {
- "delete" : {
- "description" : "Delete a `Database`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "/api/ee/action-v2/execute-form" : {
+ "post" : {
+ "description" : "Temporary endpoint for describing an actions parameters\n such that they can be presented correctly in a modal ahead of execution.",
+ "operationId" : "post-api-ee-action-v2-execute-form",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19031,47 +25514,15 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/database/{id}",
- "tags" : [ "/api/database" ]
- },
+ "summary" : "POST /api/ee/action-v2/execute-form",
+ "tags" : [ "/api/ee/action-v2" ]
+ }
+ },
+ "/api/ee/advanced-permissions/application/graph" : {
"get" : {
- "description" : "Get a single Database with `id`. Optionally pass `?include=tables` or `?include=tables.fields` to include the Tables\n belonging to this database, or the Tables and Fields, respectively. If the requestor has write permissions for the\n DB\n (i.e. is an admin or has data model permissions), then certain inferred secret values will also be included in the\n returned details (see [[metabase.secrets.models.secret/expand-db-details-inferred-secret-values]] for full details).\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.\n In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID\n and tables, with no additional metadata.\n\n Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in\n [[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for `:model/Database`\n in [[metabase.warehouses.models.database]] to exclude the `details` field, if the requesting user lacks permission to change the\n database details.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "enum" : [ "tables", "tables.fields" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include_editable_data_model",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "exclude_uneditable_details",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
- } ],
+ "description" : "Fetch a graph of Application Permissions.",
+ "operationId" : "get-api-ee-advanced-permissions-application-graph",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19083,120 +25534,42 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}",
- "tags" : [ "/api/database" ]
+ "summary" : "GET /api/ee/advanced-permissions/application/graph",
+ "tags" : [ "/api/ee/advanced-permissions/application" ]
},
"put" : {
- "description" : "Update a `Database`.",
+ "description" : "Do a batch update of Application Permissions by passing a modified graph.",
+ "operationId" : "put-api-ee-advanced-permissions-application-graph",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
+ "in" : "query",
+ "name" : "skip-graph",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "force",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "auto_run_queries" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "cache_ttl" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "caveats" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "details" : {
- "oneOf" : [ {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "engine" : {
- "oneOf" : [ {
- "description" : "value must be a valid database engine.",
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "points_of_interest" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "provider_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "refingerprint" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "schedules" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.sync.schedules.ExpandedSchedulesMap"
- }, {
- "type" : "null"
- } ]
- },
- "settings" : {
- "oneOf" : [ {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- }
- },
+ "properties" : { },
"type" : "object"
}
}
@@ -19213,42 +25586,36 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/database/{id}",
- "tags" : [ "/api/database" ]
+ "summary" : "PUT /api/ee/advanced-permissions/application/graph",
+ "tags" : [ "/api/ee/advanced-permissions/application" ]
}
},
- "/api/database/{id}/autocomplete_suggestions" : {
+ "/api/ee/advanced-permissions/impersonation" : {
"get" : {
- "description" : "Return a list of autocomplete suggestions for a given `prefix`, or `substring`. Should only specify one, but\n `substring` will have priority if both are present.\n\n This is intended for use with the ACE Editor when the User is typing raw SQL. Suggestions include matching `Tables`\n and `Fields` in this `Database`.\n\n Tables are returned in the format `[table_name \"Table\"]`;\n When Fields have a semantic_type, they are returned in the format `[field_name \"table_name base_type semantic_type\"]`\n When Fields lack a semantic_type, they are returned in the format `[field_name \"table_name base_type\"]`",
+ "description" : "Fetch a list of all Impersonation policies currently in effect, or a single policy if both `group_id` and `db_id`\n are provided.",
+ "operationId" : "get-api-ee-advanced-permissions-impersonation",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
"in" : "query",
- "name" : "prefix",
+ "name" : "group_id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "substring",
+ "name" : "db_id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
@@ -19265,13 +25632,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/autocomplete_suggestions",
- "tags" : [ "/api/database" ]
+ "summary" : "GET /api/ee/advanced-permissions/impersonation",
+ "tags" : [ "/api/ee/advanced-permissions/impersonation" ]
}
},
- "/api/database/{id}/card_autocomplete_suggestions" : {
- "get" : {
- "description" : "Return a list of `Card` autocomplete suggestions for a given `query` in a given `Database`.\n\n This is intended for use with the ACE Editor when the User is typing in a template tag for a `Card`, e.g. {{#...}}.",
+ "/api/ee/advanced-permissions/impersonation/{id}" : {
+ "delete" : {
+ "description" : "Delete a Connection Impersonation entry.",
+ "operationId" : "delete-api-ee-advanced-permissions-impersonation-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -19281,21 +25649,6 @@
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "query",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "include_dashboard_questions",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
} ],
"responses" : {
"2XX" : {
@@ -19308,23 +25661,70 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/card_autocomplete_suggestions",
- "tags" : [ "/api/database" ]
- }
- },
- "/api/database/{id}/discard_values" : {
- "post" : {
- "description" : "Discards all saved field values for this `Database`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "summary" : "DELETE /api/ee/advanced-permissions/impersonation/{id}",
+ "tags" : [ "/api/ee/advanced-permissions/impersonation" ]
+ }
+ },
+ "/api/ee/ai-entity-analysis/analyze-chart" : {
+ "post" : {
+ "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.",
+ "operationId" : "post-api-ee-ai-entity-analysis-analyze-chart",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "image_base64" : {
+ "type" : "string"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timeline_events" : {
+ "oneOf" : [ {
+ "items" : {
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "timestamp" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "timestamp" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "image_base64" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19336,23 +25736,41 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/database/{id}/discard_values",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/ai-entity-analysis/analyze-chart",
+ "tags" : [ "/api/ee/ai-entity-analysis" ]
}
},
- "/api/database/{id}/dismiss_spinner" : {
+ "/api/ee/ai-sql-fixer/fix" : {
"post" : {
- "description" : "Manually set the initial sync status of the `Database` and corresponding\n tables to be `complete` (see #20863)",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "description" : "Suggest fixes for a SQL query.",
+ "operationId" : "post-api-ee-ai-sql-fixer-fix",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "error_message" : {
+ "type" : "string"
+ },
+ "query" : {
+ "properties" : {
+ "database" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "database" ],
+ "type" : "object"
+ }
+ },
+ "required" : [ "query", "error_message" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19364,23 +25782,36 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/database/{id}/dismiss_spinner",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/ai-sql-fixer/fix",
+ "tags" : [ "/api/ee/ai-sql-fixer" ]
}
},
- "/api/database/{id}/fields" : {
- "get" : {
- "description" : "Get a list of all `Fields` in `Database`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "/api/ee/ai-sql-generation/generate" : {
+ "post" : {
+ "description" : "Generate a SQL query.",
+ "operationId" : "post-api-ee-ai-sql-generation-generate",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "database_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "prompt" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "prompt", "database_id" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19392,25 +25823,28 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/fields",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/ai-sql-generation/generate",
+ "tags" : [ "/api/ee/ai-sql-generation" ]
}
},
- "/api/database/{id}/healthcheck" : {
- "get" : {
- "description" : "Reports whether the database can currently connect",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "/api/ee/audit-app/analytics-dev/export" : {
+ "post" : {
+ "description" : "Export analytics content as a .tar.gz file for local development.\n\n Only available when MB_ANALYTICS_DEV_MODE=true. Returns a tarball containing\n the analytics YAMLs in canonical format, ready to commit to source control.\n\n Requires superuser permissions.",
+ "operationId" : "post-api-ee-audit-app-analytics-dev-export",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "body" : { }
+ },
+ "required" : [ "body" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -19420,23 +25854,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/healthcheck",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/audit-app/analytics-dev/export",
+ "tags" : [ "/api/ee/audit-app/analytics-dev" ]
}
},
- "/api/database/{id}/idfields" : {
+ "/api/ee/audit-app/user/audit-info" : {
"get" : {
- "description" : "Get a list of all primary key `Fields` for `Database`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "Gets audit info for the current user if he has permissions to access the audit collection.\n Otherwise return an empty map.",
+ "operationId" : "get-api-ee-audit-app-user-audit-info",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19448,13 +25874,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/idfields",
- "tags" : [ "/api/database" ]
+ "summary" : "GET /api/ee/audit-app/user/audit-info",
+ "tags" : [ "/api/ee/audit-app/user" ]
}
},
- "/api/database/{id}/metadata" : {
- "get" : {
- "description" : "Get metadata about a `Database`, including all of its `Tables` and `Fields`. Returns DB, fields, and field values.\n By default only non-hidden tables and fields are returned. Passing include_hidden=true includes them.\n\n Passing include_editable_data_model will only return tables for which the current user has data model editing\n permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.\n In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID\n and tables, with no additional metadata.",
+ "/api/ee/audit-app/user/{id}/subscriptions" : {
+ "delete" : {
+ "description" : "Delete all Alert and DashboardSubscription subscriptions for a User (i.e., so they will no longer receive them).\n Archive all Alerts and DashboardSubscriptions created by the User. Only allowed for admins or for the current user.",
+ "operationId" : "delete-api-ee-audit-app-user-id-subscriptions",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -19464,54 +25891,6 @@
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "include_hidden",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include_editable_data_model",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "remove_inactive",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "skip_fields",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
} ],
"responses" : {
"2XX" : {
@@ -19524,23 +25903,110 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/metadata",
- "tags" : [ "/api/database" ]
+ "summary" : "DELETE /api/ee/audit-app/user/{id}/subscriptions",
+ "tags" : [ "/api/ee/audit-app/user" ]
}
},
- "/api/database/{id}/rescan_values" : {
+ "/api/ee/autodescribe/card/summarize" : {
"post" : {
- "description" : "Trigger a manual scan of the field values for this `Database`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "description" : "Summarize a question.",
+ "operationId" : "post-api-ee-autodescribe-card-summarize",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "cache_ttl" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "parameter_mappings" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "result_metadata" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "visualization_settings" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ }
+ },
+ "required" : [ "dataset_query", "display", "visualization_settings" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19552,13 +26018,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/database/{id}/rescan_values",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/autodescribe/card/summarize",
+ "tags" : [ "/api/ee/autodescribe" ]
}
},
- "/api/database/{id}/schema/" : {
- "get" : {
- "description" : "Return a list of Tables for a Database whose `schema` is `nil` or an empty string.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can query\n - `can-write-metadata=true` - filter to only tables the user can edit metadata for",
+ "/api/ee/autodescribe/dashboard/summarize/{id}" : {
+ "post" : {
+ "description" : "Provide a summary of a dashboard.",
+ "operationId" : "post-api-ee-autodescribe-dashboard-summarize-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -19568,52 +26035,6 @@
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "include_hidden",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include_editable_data_model",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-query",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-write-metadata",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
} ],
"responses" : {
"2XX" : {
@@ -19626,77 +26047,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/schema/",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/autodescribe/dashboard/summarize/{id}",
+ "tags" : [ "/api/ee/autodescribe" ]
}
},
- "/api/database/{id}/schema/{schema}" : {
+ "/api/ee/billing" : {
"get" : {
- "description" : "Returns a list of Tables for the given Database `id` and `schema`.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can query\n - `can-write-metadata=true` - filter to only tables the user can edit metadata for",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "path",
- "name" : "schema",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "include_hidden",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include_editable_data_model",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-query",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-write-metadata",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- } ],
+ "description" : "Get billing information. This acts as a proxy between `metabase-billing-info-url` and the client,\n using the embedding token and signed in user's email to fetch the billing information.",
+ "operationId" : "get-api-ee-billing",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19708,81 +26067,17 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/schema/{schema}",
- "tags" : [ "/api/database" ]
+ "summary" : "GET /api/ee/billing",
+ "tags" : [ "/api/ee/billing" ]
}
},
- "/api/database/{id}/schemas" : {
- "get" : {
- "description" : "Returns a list of all the schemas with tables found for the database `id`. Excludes schemas with no tables.\n\n Optional filters:\n - `can-query=true` - filter to only schemas containing tables the user can query\n - `can-write-metadata=true` - filter to only schemas containing tables the user can edit metadata for",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "include_editable_data_model",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "include_hidden",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-query",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-write-metadata",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- } ],
+ "/api/ee/cloud-add-ons/addons" : {
+ "get" : {
+ "description" : "Get addons information from the Metabase Store API.",
+ "operationId" : "get-api-ee-cloud-add-ons-addons",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "items" : {
- "type" : "string"
- },
- "type" : "array"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -19792,38 +26087,70 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/schemas",
- "tags" : [ "/api/database" ]
+ "summary" : "GET /api/ee/cloud-add-ons/addons",
+ "tags" : [ "/api/ee/cloud-add-ons" ]
}
},
- "/api/database/{id}/settings-available" : {
+ "/api/ee/cloud-add-ons/plans" : {
"get" : {
- "description" : "Get all database-local settings and their availability for the given database.",
+ "description" : "Get plans information from the Metabase Store API.",
+ "operationId" : "get-api-ee-cloud-add-ons-plans",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/ee/cloud-add-ons/plans",
+ "tags" : [ "/api/ee/cloud-add-ons" ]
+ }
+ },
+ "/api/ee/cloud-add-ons/{product-type}" : {
+ "post" : {
+ "description" : "Purchase an add-on.",
+ "operationId" : "post-api-ee-cloud-add-ons-product-type",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "product-type",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "enum" : [ "metabase-ai", "metabase-ai-tiered", "python-execution", "transforms", "transforms-basic", "transforms-advanced" ],
+ "type" : "string"
}
} ],
- "responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "settings" : {
- "$ref" : "#/components/schemas/metabase.warehouses-rest.api.available-settings"
- }
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "quantity" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "settings" ],
- "type" : "object"
- }
+ "terms_of_service" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
}
- },
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
"description" : "Successful response"
},
"4XX" : {
@@ -19833,23 +26160,37 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/settings-available",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/cloud-add-ons/{product-type}",
+ "tags" : [ "/api/ee/cloud-add-ons" ]
}
},
- "/api/database/{id}/sync_schema" : {
+ "/api/ee/cloud-proxy/{operation-id}" : {
"post" : {
- "description" : "Trigger a manual update of the schema metadata for this `Database`.",
+ "description" : "Proxy a call to the Metabase Store API via harbormaster client.\n This endpoint is used only for hosted instances, and calls Harbormaster Store using a OpenAPI client.\n :operation-id is the operation-id of the Harbormaster Store endpoint.\n All parameters for the operation are taken in the POST body.",
+ "operationId" : "post-api-ee-cloud-proxy-operation-id",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "operation-id",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "minLength" : 1,
+ "type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19861,23 +26202,15 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/database/{id}/sync_schema",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/cloud-proxy/{operation-id}",
+ "tags" : [ "/api/ee/cloud-proxy" ]
}
},
- "/api/database/{id}/syncable_schemas" : {
+ "/api/ee/content-translation/csv" : {
"get" : {
- "description" : "Returns a list of all syncable schemas found for the database `id`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "Provides content translation dictionary in CSV",
+ "operationId" : "get-api-ee-content-translation-csv",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19889,25 +26222,54 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/syncable_schemas",
- "tags" : [ "/api/database" ]
+ "summary" : "GET /api/ee/content-translation/csv",
+ "tags" : [ "/api/ee/content-translation" ]
}
},
- "/api/database/{id}/usage_info" : {
+ "/api/ee/content-translation/dictionary" : {
"get" : {
- "description" : "Get usage info for a database.\n Returns a map with keys are models and values are the number of entities that use this database.",
+ "description" : "Fetch the content translation dictionary for authenticated users (auth-based embedding flows).",
+ "operationId" : "get-api-ee-content-translation-dictionary",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
+ "in" : "query",
+ "name" : "locale",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "type" : "string"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "data" : {
+ "items" : {
+ "properties" : {
+ "locale" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "msgid" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "msgstr" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "locale", "msgid", "msgstr" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "data" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -19917,14 +26279,23 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{id}/usage_info",
- "tags" : [ "/api/database" ]
+ "summary" : "GET /api/ee/content-translation/dictionary",
+ "tags" : [ "/api/ee/content-translation" ]
}
},
- "/api/database/{virtual-db}/datasets" : {
+ "/api/ee/content-translation/dictionary/{token}" : {
"get" : {
- "description" : "Returns a list of all the datasets found for the saved questions virtual database.",
- "parameters" : [ ],
+ "description" : "Fetch the content translation dictionary via a JSON Web Token signed with the `embedding-secret-key`.",
+ "operationId" : "get-api-ee-content-translation-dictionary-token",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19936,14 +26307,37 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{virtual-db}/datasets",
- "tags" : [ "/api/database" ]
+ "summary" : "GET /api/ee/content-translation/dictionary/{token}",
+ "tags" : [ "/api/ee/content-translation" ]
}
},
- "/api/database/{virtual-db}/datasets/{schema}" : {
- "get" : {
- "description" : "Returns a list of Tables for the datasets virtual database.",
+ "/api/ee/content-translation/upload-dictionary" : {
+ "post" : {
+ "description" : "Upload a CSV of content translations",
+ "operationId" : "post-api-ee-content-translation-upload-dictionary",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "multipart/form-data" : {
+ "schema" : {
+ "properties" : {
+ "file" : {
+ "properties" : {
+ "filename" : {
+ "type" : "string"
+ },
+ "tempfile" : { }
+ },
+ "required" : [ "filename", "tempfile" ],
+ "type" : "object"
+ }
+ },
+ "required" : [ "file" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -19955,16 +26349,33 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{virtual-db}/datasets/{schema}",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/content-translation/upload-dictionary",
+ "tags" : [ "/api/ee/content-translation" ]
}
},
- "/api/database/{virtual-db}/metadata" : {
- "get" : {
- "description" : "Endpoint that provides metadata for the Saved Questions 'virtual' database. Used for fooling the frontend\n and allowing it to treat the Saved Questions virtual DB just like any other database.",
+ "/api/ee/data-studio/table/publish-tables" : {
+ "post" : {
+ "description" : "Set collection for each of selected tables and all upstream dependencies recursively.",
+ "operationId" : "post-api-ee-data-studio-table-publish-tables",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.publish-tables-response"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -19974,16 +26385,33 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{virtual-db}/metadata",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/data-studio/table/publish-tables",
+ "tags" : [ "/api/ee/data-studio/table" ]
}
},
- "/api/database/{virtual-db}/schema/{schema}" : {
- "get" : {
- "description" : "Returns a list of Tables for the saved questions virtual database.",
+ "/api/ee/data-studio/table/unpublish-tables" : {
+ "post" : {
+ "description" : "Unset collection for each of selected tables and all downstream dependents recursively.",
+ "operationId" : "post-api-ee-data-studio-table-unpublish-tables",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -19993,14 +26421,24 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{virtual-db}/schema/{schema}",
- "tags" : [ "/api/database" ]
+ "summary" : "POST /api/ee/data-studio/table/unpublish-tables",
+ "tags" : [ "/api/ee/data-studio/table" ]
}
},
- "/api/database/{virtual-db}/schemas" : {
- "get" : {
- "description" : "Returns a list of all the schemas found for the saved questions virtual database.",
- "parameters" : [ ],
+ "/api/ee/database-replication/connection/{database-id}" : {
+ "delete" : {
+ "description" : "Delete PG replication connection for the specified database.",
+ "operationId" : "delete-api-ee-database-replication-connection-database-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "database-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -20012,25 +26450,39 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/database/{virtual-db}/schemas",
- "tags" : [ "/api/database" ]
- }
- },
- "/api/dataset/" : {
+ "summary" : "DELETE /api/ee/database-replication/connection/{database-id}",
+ "tags" : [ "/api/ee/database-replication" ]
+ },
"post" : {
- "description" : "Execute a query and retrieve the results in the usual format. The query will not use the cache.",
- "parameters" : [ ],
+ "description" : "Create a new PG replication connection for the specified database.",
+ "operationId" : "post-api-ee-database-replication-connection-database-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "database-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "database" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "replicationSchemaFilters" : {
+ "properties" : {
+ "schema-filters-patterns" : {
+ "type" : "string"
+ },
+ "schema-filters-type" : {
+ "enum" : [ "inclusion", "exclusion", "all" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "schema-filters-type", "schema-filters-patterns" ],
+ "type" : "object"
}
},
"type" : "object"
@@ -20049,34 +26501,43 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dataset/",
- "tags" : [ "/api/dataset" ]
+ "summary" : "POST /api/ee/database-replication/connection/{database-id}",
+ "tags" : [ "/api/ee/database-replication" ]
}
},
- "/api/dataset/native" : {
+ "/api/ee/database-replication/connection/{database-id}/preview" : {
"post" : {
- "description" : "Fetch a native version of an MBQL query.",
- "parameters" : [ ],
+ "description" : "Return info about pg-replication connection that is about to be created.",
+ "operationId" : "post-api-ee-database-replication-connection-database-id-preview",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "database-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "database" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "pretty" : {
- "default" : true,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "replicationSchemaFilters" : {
+ "properties" : {
+ "schema-filters-patterns" : {
+ "type" : "string"
+ },
+ "schema-filters-type" : {
+ "enum" : [ "inclusion", "exclusion", "all" ],
+ "type" : "string"
+ }
+ },
+ "required" : [ "schema-filters-type", "schema-filters-patterns" ],
+ "type" : "object"
}
},
- "required" : [ "database", "pretty" ],
"type" : "object"
}
}
@@ -20093,35 +26554,52 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dataset/native",
- "tags" : [ "/api/dataset" ]
+ "summary" : "POST /api/ee/database-replication/connection/{database-id}/preview",
+ "tags" : [ "/api/ee/database-replication" ]
}
},
- "/api/dataset/parameter/remapping" : {
+ "/api/ee/database-routing/destination-database" : {
"post" : {
- "description" : "Return the remapped parameter values for cards or dashboards that are being edited.",
- "parameters" : [ ],
+ "description" : "Create new Destination Databases.\n\n Note that unlike the normal `POST /api/database` endpoint, does NOT check the details before adding the Database.\n\n This is OK, it's not an invariant that all database details are always valid, but it's something to note.",
+ "operationId" : "post-api-ee-database-routing-destination-database",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "check_connection_details",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "field_ids" : {
- "oneOf" : [ {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ "destinations" : {
+ "items" : {
+ "properties" : {
+ "details" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
},
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "parameter" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
+ "required" : [ "name", "details" ],
+ "type" : "object"
+ },
+ "type" : "array"
},
- "value" : { }
+ "router_database_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
},
- "required" : [ "parameter", "value" ],
+ "required" : [ "router_database_id", "destinations" ],
"type" : "object"
}
}
@@ -20138,20 +26616,22 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dataset/parameter/remapping",
- "tags" : [ "/api/dataset" ]
+ "summary" : "POST /api/ee/database-routing/destination-database",
+ "tags" : [ "/api/ee/database-routing" ]
}
},
- "/api/dataset/parameter/search/{query}" : {
- "post" : {
- "description" : "Return parameter values for cards or dashboards that are being edited. Expects a query string at `?query=foo`.",
+ "/api/ee/database-routing/router-database/{id}" : {
+ "put" : {
+ "description" : "Updates an existing Database with the `user_attribute` to route on. Will either:\n - turn an existing Database into a Router database\n - change the `user_attribute` used to route for an existing Router database, or\n - turn a Router database into a regular Database\n depending on the value of `user_attribute`",
+ "operationId" : "put-api-ee-database-routing-router-database-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "query",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"requestBody" : {
@@ -20159,21 +26639,15 @@
"application/json" : {
"schema" : {
"properties" : {
- "field_ids" : {
+ "user_attribute" : {
"oneOf" : [ {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "type" : "array"
+ "minLength" : 1,
+ "type" : "string"
}, {
"type" : "null"
} ]
- },
- "parameter" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
}
},
- "required" : [ "parameter" ],
"type" : "object"
}
}
@@ -20190,34 +26664,67 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dataset/parameter/search/{query}",
- "tags" : [ "/api/dataset" ]
+ "summary" : "PUT /api/ee/database-routing/router-database/{id}",
+ "tags" : [ "/api/ee/database-routing" ]
}
},
- "/api/dataset/parameter/values" : {
+ "/api/ee/dependencies/check-card" : {
"post" : {
- "description" : "Return parameter values for cards or dashboards that are being edited.",
+ "description" : "Check a proposed edit to a card, and return the card IDs for those cards this edit will break.",
+ "operationId" : "post-api-ee-dependencies-check-card",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-body"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.broken-cards-response"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/ee/dependencies/check-card",
+ "tags" : [ "/api/ee/dependencies" ]
+ }
+ },
+ "/api/ee/dependencies/check-snippet" : {
+ "post" : {
+ "description" : "Check a proposed edit to a native snippet, and return the cards, etc. which will be broken.",
+ "operationId" : "post-api-ee-dependencies-check-snippet",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "field_ids" : {
- "oneOf" : [ {
- "items" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
+ "content" : {
+ "type" : "string"
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
},
- "parameter" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
+ "name" : {
+ "description" : "snippet names cannot include '}' or start with spaces"
}
},
- "required" : [ "parameter" ],
+ "required" : [ "id" ],
"type" : "object"
}
}
@@ -20225,6 +26732,13 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.broken-cards-response"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -20234,33 +26748,33 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dataset/parameter/values",
- "tags" : [ "/api/dataset" ]
+ "summary" : "POST /api/ee/dependencies/check-snippet",
+ "tags" : [ "/api/ee/dependencies" ]
}
},
- "/api/dataset/pivot" : {
+ "/api/ee/dependencies/check-transform" : {
"post" : {
- "description" : "Generate a pivoted dataset for an ad-hoc query",
+ "description" : "Check a proposed edit to a transform, and return the card, transform, etc. IDs for things that will break.",
+ "operationId" : "post-api-ee-dependencies-check-transform",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "database" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "database" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-body"
}
}
}
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.broken-cards-response"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -20270,33 +26784,163 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dataset/pivot",
- "tags" : [ "/api/dataset" ]
+ "summary" : "POST /api/ee/dependencies/check-transform",
+ "tags" : [ "/api/ee/dependencies" ]
}
},
- "/api/dataset/query_metadata" : {
- "post" : {
- "description" : "Get all of the required query metadata for an ad-hoc query.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "database" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "database" ],
- "type" : "object"
+ "/api/ee/dependencies/graph" : {
+ "get" : {
+ "description" : "This endpoint takes an :id and a supported entity :type, and returns a graph of all its upstream dependencies.\n The graph is represented by a list of :nodes and a list of :edges. Each node has an :id, :type, :data (which\n depends on the node type), and a map of :dependent_counts per entity type. Each edge is a :model/Dependency.\n\n Optional :archived parameter controls whether entities in archived collections are included:\n - false (default): Excludes entities in archived collections\n - true: Includes entities in archived collections",
+ "operationId" : "get-api-ee-dependencies-graph",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "id",
+ "required" : false,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "type",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.graph-response"
+ }
}
- }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/ee/dependencies/graph",
+ "tags" : [ "/api/ee/dependencies" ]
+ }
+ },
+ "/api/ee/dependencies/graph/breaking" : {
+ "get" : {
+ "description" : "Returns a list of entities that are breaking other entities (sources of errors).\n These are tables or cards that other entities depend on, where those dependents\n have validation errors traced back to this source entity.\n\n Accepts optional parameters for filtering:\n - `types`: List of source entity types - only `:card` or `:table` (default: both)\n - `card-types`: List of card types to include when filtering cards (e.g., `[:question :model :metric]`)\n - `query`: Search string to filter by name or location\n - `archived`: Controls whether archived entities are included\n - `include-personal-collections`: Controls whether items in personal collections are included (default: false)\n - `sort-column`: Sort column - `:name`, `:location`, `:dependents-errors`, or `:dependents-with-errors` (default: `:name`)\n - `sort-direction`: Sort direction - `:asc` or `:desc` (default: `:asc`)\n - `offset`: Default 0\n - `limit`: Default 50\n\n Returns a map with:\n - `data`: List of breaking source entities\n - `total`: Total count of matched items\n - `offset`: Applied offset\n - `limit`: Applied limit",
+ "operationId" : "get-api-ee-dependencies-graph-breaking",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }, {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ },
+ "type" : "array"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "card-types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "enum" : [ "question", "metric", "model" ],
+ "type" : "string"
+ }, {
+ "items" : {
+ "enum" : [ "question", "metric", "model" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "include-personal-collections",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-column",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "dependents-with-errors", "dependents-errors", "name", "location" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-direction",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "desc", "asc" ],
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "data" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
+ },
+ "type" : "array"
+ },
+ "limit" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "offset" : {
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "total" : {
+ "minimum" : 0,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "data", "total", "offset", "limit" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -20306,52 +26950,332 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dataset/query_metadata",
- "tags" : [ "/api/dataset" ]
+ "summary" : "GET /api/ee/dependencies/graph/breaking",
+ "tags" : [ "/api/ee/dependencies" ]
}
},
- "/api/dataset/{export-format}" : {
- "post" : {
- "description" : "Execute a query and download the result data as a file in the specified format.",
+ "/api/ee/dependencies/graph/broken" : {
+ "get" : {
+ "description" : "Returns the broken dependents for a specific source entity.\n These are entities that have validation errors traced back to the specified source.\n\n Required parameters:\n - `id`: The ID of the source entity\n - `type`: The type of the source entity (card, table)\n\n Optional parameters:\n - `dependent-types`: Dependency types to filter by. Can be single value or array.\n - `dependent-card-types`: Card types to filter by when dependent-types includes :card.\n - `include-personal-collections`: Include items in personal collections (default: false)\n - `sort-column`: Column to sort by - name, location, or view-count (default: name)\n - `sort-direction`: Sort direction - asc or desc (default: asc)",
+ "operationId" : "get-api-ee-dependencies-graph-broken",
"parameters" : [ {
- "in" : "path",
- "name" : "export-format",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "id",
"required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "type",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }
+ }, {
+ "in" : "query",
+ "name" : "dependent-types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }, {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ },
+ "type" : "array"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "dependent-card-types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "enum" : [ "question", "metric", "model" ],
+ "type" : "string"
+ }, {
+ "items" : {
+ "enum" : [ "question", "metric", "model" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include-personal-collections",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-column",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "name", "view-count", "location" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-direction",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "desc", "asc" ],
+ "type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "format_rows" : {
- "default" : false,
- "type" : "boolean"
- },
- "pivot_results" : {
- "default" : false,
- "type" : "boolean"
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.broken-dependent-entity"
},
- "query" : {
- "properties" : { },
- "type" : "object"
+ "type" : "array"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/ee/dependencies/graph/broken",
+ "tags" : [ "/api/ee/dependencies" ]
+ }
+ },
+ "/api/ee/dependencies/graph/dependents" : {
+ "get" : {
+ "description" : "Returns a list of dependents for the specified entity.\n\n Required parameters:\n - `id`: The ID of the entity\n - `type`: The type of the entity (card, table, dashboard, etc.)\n\n Optional parameters:\n - `dependent-types`: Dependency types to filter by. Can be single value or array.\n If not provided, returns all types. Example: ?dependent-types=card&dependent-types=dashboard\n - `dependent-card-types`: Card types to filter by when dependent-types includes :card.\n Ignored if dependent-types doesn't include :card. Example: ?dependent-card-types=question&dependent-card-types=model\n - `archived`: Include entities in archived collections (default: false)\n - `broken`: Return only broken entities (default: false)\n - `query`: Search string to filter results by name or location (case-insensitive)\n - `include-personal-collections`: Include items in personal collections (default: false)\n - `sort-column`: Column to sort by - name, location, or view-count (default: name)\n - `sort-direction`: Sort direction - asc or desc (default: asc)",
+ "operationId" : "get-api-ee-dependencies-graph-dependents",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "type",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }
+ }, {
+ "in" : "query",
+ "name" : "dependent-types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }, {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ },
+ "type" : "array"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "dependent-card-types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "enum" : [ "question", "metric", "model" ],
+ "type" : "string"
+ }, {
+ "items" : {
+ "enum" : [ "question", "metric", "model" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "broken",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "include-personal-collections",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-column",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "name", "view-count", "location" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-direction",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "desc", "asc" ],
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
},
- "visualization_settings" : {
- "default" : { },
- "properties" : { },
- "type" : "object"
- }
- },
- "required" : [ "query", "visualization_settings", "format_rows", "pivot_results" ],
- "type" : "object"
+ "type" : "array"
+ }
}
- }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/ee/dependencies/graph/dependents",
+ "tags" : [ "/api/ee/dependencies" ]
+ }
+ },
+ "/api/ee/dependencies/graph/unreferenced" : {
+ "get" : {
+ "description" : "Returns a list of all unreferenced items in the instance.\n An unreferenced item is one that is not a dependency of any other item.\n\n Accepts optional parameters for filtering:\n - `types`: List of entity types to include (e.g., [:card :transform :snippet :dashboard])\n - `card-types`: List of card types to include when filtering cards (e.g., [:question :model :metric])\n - `query`: Search string to filter by name or location\n - `archived`: Controls whether archived entities are included\n - `include-personal-collections`: Controls whether items in personal collections are included (default: false)\n - `sort-column`: Sort column - `:name`, `:location`, `:dependents-errors`, or `:dependents-with-errors` (default: `:name`)\n - `sort-direction`: Sort direction - `:asc` or `:desc` (default: `:asc`)\n - `offset`: Default 0\n - `limit`: Default 50\n\n Returns a map with:\n - `data`: List of unreferenced items, each with `:id`, `:type`, and `:data` fields\n - `total`: Total count of matched items\n - `offset`: Applied offset\n - `limit`: Applied limit",
+ "operationId" : "get-api-ee-dependencies-graph-unreferenced",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ }, {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
+ },
+ "type" : "array"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "card-types",
+ "required" : false,
+ "schema" : {
+ "anyOf" : [ {
+ "enum" : [ "question", "metric", "model" ],
+ "type" : "string"
+ }, {
+ "items" : {
+ "enum" : [ "question", "metric", "model" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "query",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "include-personal-collections",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-column",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "dependents-with-errors", "dependents-errors", "name", "location" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort-direction",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "desc", "asc" ],
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "data" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
+ },
+ "type" : "array"
+ },
+ "limit" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "offset" : {
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "total" : {
+ "minimum" : 0,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "data", "total", "offset", "limit" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -20361,13 +27285,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/dataset/{export-format}",
- "tags" : [ "/api/dataset" ]
+ "summary" : "GET /api/ee/dependencies/graph/unreferenced",
+ "tags" : [ "/api/ee/dependencies" ]
}
},
- "/api/document/" : {
- "get" : {
- "description" : "Gets existing `Documents`.",
+ "/api/ee/email/override" : {
+ "delete" : {
+ "description" : "Clear all cloud email related settings. You must be a superuser or have `setting` permission to do this.",
+ "operationId" : "delete-api-ee-email-override",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -20380,135 +27305,54 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/document/",
- "tags" : [ "/api/document" ]
+ "summary" : "DELETE /api/ee/email/override",
+ "tags" : [ "/api/ee/email" ]
},
- "post" : {
- "description" : "Create a new `Document`.",
+ "put" : {
+ "description" : "Update multiple cloud email Settings. You must be a superuser or have `setting` permission to do this.\n Calling this automatically sets `cloud-smtp-enabled` to true if the settings are valid.",
+ "operationId" : "put-api-ee-email-override",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "cards" : {
- "oneOf" : [ {
- "additionalProperties" : {
- "properties" : {
- "cache_ttl" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "dataset_query" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "description" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display" : {
- "minLength" : 1,
- "type" : "string"
- },
- "entity_id" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "items" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "parameters" : {
- "oneOf" : [ {
- "items" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "result_metadata" : {
- "oneOf" : [ {
- "items" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "visualization_settings" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- }
- },
- "required" : [ "name", "dataset_query", "display", "visualization_settings" ],
- "type" : "object"
- },
- "type" : "object"
+ "email-smtp-host-override" : {
+ "anyOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "email-smtp-password-override" : {
+ "anyOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
+ "email-smtp-port-override" : {
+ "anyOf" : [ {
"type" : "integer"
}, {
"type" : "null"
} ]
},
- "document" : { },
- "name" : {
- "maxLength" : 254,
- "minLength" : 1,
- "type" : "string"
+ "email-smtp-security-override" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email-smtp-username-override" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "name", "document" ],
"type" : "object"
}
}
@@ -20525,39 +27369,76 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/document/",
- "tags" : [ "/api/document" ]
+ "summary" : "PUT /api/ee/email/override",
+ "tags" : [ "/api/ee/email" ]
}
},
- "/api/document/public" : {
+ "/api/ee/embedding-hub/checklist" : {
"get" : {
- "description" : "List all Documents that have public links.\n\n Returns a sequence of Documents that have been publicly shared. Each Document includes its `:id`, `:name`,\n and `:public_uuid`. Documents are only actually accessible via the public endpoint if public sharing is\n currently enabled. Archived Documents are excluded from the results.\n\n This endpoint is used to populate the public links listing in the Admin settings UI.\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.",
+ "description" : "Get the embedding hub checklist status, indicating which setup steps have been completed.",
+ "operationId" : "get-api-ee-embedding-hub-checklist",
"parameters" : [ ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "items" : {
- "properties" : {
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "name" : {
- "type" : "string"
+ "additionalProperties" : false,
+ "properties" : {
+ "checklist" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "add-data" : {
+ "type" : "boolean"
+ },
+ "configure-row-column-security" : {
+ "type" : "boolean"
+ },
+ "create-dashboard" : {
+ "type" : "boolean"
+ },
+ "create-models" : {
+ "type" : "boolean"
+ },
+ "create-tenants" : {
+ "type" : "boolean"
+ },
+ "create-test-embed" : {
+ "type" : "boolean"
+ },
+ "data-permissions-and-enable-tenants" : {
+ "type" : "boolean"
+ },
+ "embed-production" : {
+ "type" : "boolean"
+ },
+ "enable-tenants" : {
+ "type" : "boolean"
+ },
+ "setup-data-segregation-strategy" : {
+ "type" : "boolean"
+ },
+ "sso-auth-manual-tested" : {
+ "type" : "boolean"
+ },
+ "sso-configured" : {
+ "type" : "boolean"
+ }
},
- "public_uuid" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
+ "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" ],
+ "type" : "object"
},
- "required" : [ "name", "id", "public_uuid" ],
- "type" : "object"
+ "data-isolation-strategy" : {
+ "oneOf" : [ {
+ "enum" : [ "row-column-level-security", "connection-impersonation", "database-routing" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "type" : "array"
+ "required" : [ "checklist", "data-isolation-strategy" ],
+ "type" : "object"
}
}
},
@@ -20570,23 +27451,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/document/public",
- "tags" : [ "/api/document" ]
+ "summary" : "GET /api/ee/embedding-hub/checklist",
+ "tags" : [ "/api/ee/embedding-hub" ]
}
},
- "/api/document/{document-id}" : {
+ "/api/ee/gsheets/connection" : {
"delete" : {
- "description" : "Permanently deletes an archived Document.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "document-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "Disconnect the google service account. There is only one (or zero) at the time of writing.",
+ "operationId" : "delete-api-ee-gsheets-connection",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -20598,23 +27471,22 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/document/{document-id}",
- "tags" : [ "/api/document" ]
+ "summary" : "DELETE /api/ee/gsheets/connection",
+ "tags" : [ "/api/ee/gsheets" ]
},
"get" : {
- "description" : "Returns an existing Document by ID.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "document-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "Check the status of a connection. This endpoint gets polled by FE to determine when to\n stop showing the setup widget.\n\n Returns the gsheets shape, with the attached datawarehouse db id at `:db_id`.",
+ "operationId" : "get-api-ee-gsheets-connection",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/gsheets.response"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -20624,150 +27496,24 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/document/{document-id}",
- "tags" : [ "/api/document" ]
+ "summary" : "GET /api/ee/gsheets/connection",
+ "tags" : [ "/api/ee/gsheets" ]
},
- "put" : {
- "description" : "Updates an existing `Document`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "document-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "post" : {
+ "description" : "Hook up a new google drive folder or sheet that will be watched and have its content ETL'd into Metabase.",
+ "operationId" : "post-api-ee-gsheets-connection",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "cards" : {
- "oneOf" : [ {
- "additionalProperties" : {
- "properties" : {
- "cache_ttl" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "dataset_query" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "description" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display" : {
- "minLength" : 1,
- "type" : "string"
- },
- "entity_id" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "parameter_mappings" : {
- "oneOf" : [ {
- "items" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "parameters" : {
- "oneOf" : [ {
- "items" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "result_metadata" : {
- "oneOf" : [ {
- "items" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "visualization_settings" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- }
- },
- "required" : [ "name", "dataset_query", "display", "visualization_settings" ],
- "type" : "object"
- },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "document" : { },
- "name" : {
- "maxLength" : 254,
+ "url" : {
"minLength" : 1,
"type" : "string"
}
},
+ "required" : [ "url" ],
"type" : "object"
}
}
@@ -20775,6 +27521,13 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/gsheets.response"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -20784,76 +27537,107 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/document/{document-id}",
- "tags" : [ "/api/document" ]
+ "summary" : "POST /api/ee/gsheets/connection",
+ "tags" : [ "/api/ee/gsheets" ]
}
},
- "/api/document/{document-id}/card/{card-id}/query/{export-format}" : {
+ "/api/ee/gsheets/connection/sync" : {
"post" : {
- "description" : "Download query results for a Card embedded in a Document.\n\n Returns query results in the requested format. The user must have read access to the document\n to download results. If the card's query fails, standard query error responses are returned.\n\n Route parameters:\n - document-id: ID of the document containing the card\n - card-id: ID of the card to download results from\n - export-format: Output format (csv, xlsx, json)\n\n Body parameters (snake_case):\n - parameters: Optional query parameters (array of maps or JSON string)\n - format_rows: Whether to apply formatting to results (boolean, default false)\n - pivot_results: Whether to pivot results (boolean, default false)",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "document-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "path",
- "name" : "export-format",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "description" : "Force a sync of the connection now.\n\n Returns the gsheets shape, with the attached datawarehouse db id at `:db_id`.",
+ "operationId" : "post-api-ee-gsheets-connection-sync",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "format_rows" : {
- "default" : false,
- "type" : "boolean"
- },
- "parameters" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "items" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
- }, {
- "description" : "value must be a valid JSON string.",
+ },
+ "summary" : "POST /api/ee/gsheets/connection/sync",
+ "tags" : [ "/api/ee/gsheets" ]
+ }
+ },
+ "/api/ee/gsheets/service-account" : {
+ "get" : {
+ "description" : "Checks to see if service-account is setup or not, delegates to HM only if we haven't set it from a metabase cluster\n before.",
+ "operationId" : "get-api-ee-gsheets-service-account",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "email" : {
+ "oneOf" : [ {
"type" : "string"
+ }, {
+ "type" : "null"
} ]
- }, {
- "type" : "null"
- } ]
+ }
},
- "pivot_results" : {
- "default" : false,
- "type" : "boolean"
- }
- },
- "required" : [ "format_rows", "pivot_results" ],
- "type" : "object"
+ "required" : [ "email" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/ee/gsheets/service-account",
+ "tags" : [ "/api/ee/gsheets" ]
+ }
+ },
+ "/api/ee/library" : {
+ "get" : {
+ "description" : "Get the Library. If no library exists, it doesn't fail but returns an empty response",
+ "operationId" : "get-api-ee-library",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItem"
+ }, {
+ "properties" : {
+ "data" : {
+ "type" : "null"
+ }
+ },
+ "required" : [ "data" ],
+ "type" : "object"
+ } ]
+ }
}
- }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/ee/library",
+ "tags" : [ "/api/ee/library" ]
+ },
+ "post" : {
+ "description" : "Creates the Library if it doesn't exist. Returns the created collection.\n\n Requires data analyst or superuser permissions.",
+ "operationId" : "post-api-ee-library",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -20865,21 +27649,42 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/document/{document-id}/card/{card-id}/query/{export-format}",
- "tags" : [ "/api/document" ]
+ "summary" : "POST /api/ee/library",
+ "tags" : [ "/api/ee/library" ]
}
},
- "/api/document/{document-id}/public-link" : {
- "delete" : {
- "description" : "Remove the public link for a Document.\n\n Deletes the public UUID from the Document, making it no longer accessible via the public sharing endpoint.\n This revokes public access to the Document - the existing public link will no longer work.\n\n Returns a 204 No Content response on success.\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.\n Throws a 404 if the Document doesn't exist, is archived, or doesn't have a public link.",
+ "/api/ee/library/tree" : {
+ "get" : {
+ "description" : "This matches /api/collection/tree but only returns the library collection.",
+ "operationId" : "get-api-ee-library-tree",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/ee/library/tree",
+ "tags" : [ "/api/ee/library" ]
+ }
+ },
+ "/api/ee/logs/query_execution/{yyyy-mm}" : {
+ "get" : {
+ "description" : "Fetch rows for the month specified by `:yyyy-mm` from the query_execution logs table.\n Must be a superuser.",
+ "operationId" : "get-api-ee-logs-query_execution-yyyy-mm",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "Must be a string like 2020-04 or 2222-11.",
"in" : "path",
- "name" : "document-id",
+ "name" : "yyyy-mm",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "\\d{4}-\\d{2}",
+ "type" : "string"
}
} ],
"responses" : {
@@ -20893,39 +27698,69 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/document/{document-id}/public-link",
- "tags" : [ "/api/document" ]
- },
+ "summary" : "GET /api/ee/logs/query_execution/{yyyy-mm}",
+ "tags" : [ "/api/ee/logs" ]
+ }
+ },
+ "/api/ee/metabot-tools/answer-sources" : {
"post" : {
- "description" : "Generate a publicly-accessible UUID for a Document.\n\n Creates a public link that allows viewing the Document without authentication. If the Document already has\n a public UUID, returns the existing one rather than generating a new one. This enables sharing the Document\n via `GET /api/ee/public/document/:uuid`.\n\n Returns a map containing `:uuid` (the public UUID string).\n\n Requires superuser permissions. Public sharing must be enabled via the `enable-public-sharing` setting.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "document-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "description" : "Return top level meta information about available information sources.",
+ "operationId" : "post-api-ee-metabot-tools-answer-sources",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.answer-sources-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "uuid" : {
+ "conversation_id" : {
"description" : "value must be a valid UUID.",
"pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "uuid" ],
+ "required" : [ "conversation_id" ],
"type" : "object"
}
}
},
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -20934,35 +27769,38 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/document/{document-id}/public-link",
- "tags" : [ "/api/document" ]
+ "summary" : "POST /api/ee/metabot-tools/answer-sources",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/action-v2/execute" : {
+ "/api/ee/metabot-tools/check-transform-dependencies" : {
"post" : {
- "description" : "Execute an action with a single input.\n\n Takes:\n - `action` - an identifier or an expression for what we want to execute.\n - `scope` - where the action is being invoked from.\n - `input` - a single map. currently these are typically a database table row pk, or query result.\n - `params` (optional) - a map of values for the parameters taken by the action's mapping.\n\n The `input` and `params` are used by the relevant mapping to calculate a map argument to the underlying action fn.\n If there is no mapping, `params` are simply used as overrides for `input`.\n\n Returns the outputs from the performed action.",
+ "description" : "Check a proposed edit to a transform and return details of cards or transforms that would be broken by the change.",
+ "operationId" : "post-api-ee-metabot-tools-check-transform-dependencies",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "action" : {
- "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"
- },
- "input" : {
- "properties" : { },
- "type" : "object"
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.check-transform-dependencies-arguments"
},
- "params" : {
- "properties" : { },
- "type" : "object"
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
},
- "scope" : {
- "$ref" : "#/components/schemas/metabase.actions.types..scope.raw"
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "action", "scope" ],
+ "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -20970,7 +27808,30 @@
},
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -20979,39 +27840,38 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/action-v2/execute",
- "tags" : [ "/api/ee/action-v2" ]
+ "summary" : "POST /api/ee/metabot-tools/check-transform-dependencies",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/action-v2/execute-bulk" : {
+ "/api/ee/metabot-tools/create-dashboard-subscription" : {
"post" : {
- "description" : "Execute an action with multiple inputs.\n\n This is typically more efficient than calling execute with each input individually, for example by performing batch\n SQL operations.\n\n Takes:\n - `action` - an identifier or an expression for what we want to execute.\n - `scope` - where the action is being invoked from.\n - `inputs` - a list of maps. currently these are typically a database table row pk, or query result.\n - `params` (optional) - a map of values for the parameters taken by the action's mapping.\n\n The `inputs` and `params` are used by the relevant mapping to calculate a list of args for the underlying action fn.\n If there is no mapping, `params` are simply used as overrides for each map within `inputs`.\n\n Returns the outputs from the performed action.",
+ "description" : "Create a dashboard subscription.",
+ "operationId" : "post-api-ee-metabot-tools-create-dashboard-subscription",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "action" : {
- "$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-id-or-expression"
- },
- "inputs" : {
- "items" : {
- "properties" : { },
- "type" : "object"
- },
- "minItems" : 1,
- "type" : "array"
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.create-dashboard-subscription-arguments"
},
- "params" : {
- "additionalProperties" : { },
- "type" : "object"
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
},
- "scope" : {
- "$ref" : "#/components/schemas/metabase.actions.types..scope.raw"
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "action", "scope", "inputs" ],
+ "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -21019,7 +27879,33 @@
},
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "output" : {
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "output", "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21028,17 +27914,69 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/action-v2/execute-bulk",
- "tags" : [ "/api/ee/action-v2" ]
+ "summary" : "POST /api/ee/metabot-tools/create-dashboard-subscription",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/action-v2/execute-form" : {
+ "/api/ee/metabot-tools/field-values" : {
"post" : {
- "description" : "Temporary endpoint for describing an actions parameters\n such that they can be presented correctly in a modal ahead of execution.",
+ "description" : "Return statistics and/or values for a given field of a given entity.",
+ "operationId" : "post-api-ee-metabot-tools-field-values",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field-values-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21047,17 +27985,69 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/action-v2/execute-form",
- "tags" : [ "/api/ee/action-v2" ]
+ "summary" : "POST /api/ee/metabot-tools/field-values",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/advanced-permissions/application/graph" : {
- "get" : {
- "description" : "Fetch a graph of Application Permissions.",
+ "/api/ee/metabot-tools/filter-records" : {
+ "post" : {
+ "description" : "Construct a query from a metric.",
+ "operationId" : "post-api-ee-metabot-tools-filter-records",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter-records-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21066,41 +28056,38 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/advanced-permissions/application/graph",
- "tags" : [ "/api/ee/advanced-permissions/application" ]
- },
- "put" : {
- "description" : "Do a batch update of Application Permissions by passing a modified graph.",
- "parameters" : [ {
- "in" : "query",
- "name" : "skip-graph",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "force",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- } ],
+ "summary" : "POST /api/ee/metabot-tools/filter-records",
+ "tags" : [ "/api/ee/metabot-tools" ]
+ }
+ },
+ "/api/ee/metabot-tools/find-outliers" : {
+ "post" : {
+ "description" : "Find outliers in the values provided by a data source for a given column.",
+ "operationId" : "post-api-ee-metabot-tools-find-outliers",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : { },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.find-outliers-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -21108,7 +28095,30 @@
},
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21117,43 +28127,78 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/advanced-permissions/application/graph",
- "tags" : [ "/api/ee/advanced-permissions/application" ]
+ "summary" : "POST /api/ee/metabot-tools/find-outliers",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/advanced-permissions/impersonation/" : {
- "get" : {
- "description" : "Fetch a list of all Impersonation policies currently in effect, or a single policy if both `group_id` and `db_id`\n are provided.",
- "parameters" : [ {
- "in" : "query",
- "name" : "group_id",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "db_id",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "/api/ee/metabot-tools/generate-insights" : {
+ "post" : {
+ "description" : "Generate insights.",
+ "operationId" : "post-api-ee-metabot-tools-generate-insights",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.generate-insights-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "output" : {
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "reactions" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabot.reaction.redirect"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "output", "reactions", "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21162,26 +28207,50 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/advanced-permissions/impersonation/",
- "tags" : [ "/api/ee/advanced-permissions/impersonation" ]
+ "summary" : "POST /api/ee/metabot-tools/generate-insights",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/advanced-permissions/impersonation/{id}" : {
- "delete" : {
- "description" : "Delete a Connection Impersonation entry.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "/api/ee/metabot-tools/get-current-user" : {
+ "post" : {
+ "description" : "Get information about user that started the conversation.",
+ "operationId" : "post-api-ee-metabot-tools-get-current-user",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21190,64 +28259,38 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/advanced-permissions/impersonation/{id}",
- "tags" : [ "/api/ee/advanced-permissions/impersonation" ]
+ "summary" : "POST /api/ee/metabot-tools/get-current-user",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/ai-entity-analysis/analyze-chart" : {
+ "/api/ee/metabot-tools/get-dashboard-details" : {
"post" : {
- "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.",
+ "description" : "Get information about a given dashboard.",
+ "operationId" : "post-api-ee-metabot-tools-get-dashboard-details",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-dashboard-details-arguments"
},
- "image_base64" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"type" : "string"
},
- "name" : {
+ "profile_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
- },
- "timeline_events" : {
- "oneOf" : [ {
- "items" : {
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "type" : "string"
- },
- "timestamp" : {
- "type" : "string"
- }
- },
- "required" : [ "name", "timestamp" ],
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
}
},
- "required" : [ "image_base64" ],
+ "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -21255,7 +28298,30 @@
},
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21264,35 +28330,38 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/ai-entity-analysis/analyze-chart",
- "tags" : [ "/api/ee/ai-entity-analysis" ]
+ "summary" : "POST /api/ee/metabot-tools/get-dashboard-details",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/ai-sql-fixer/fix" : {
+ "/api/ee/metabot-tools/get-document-details" : {
"post" : {
- "description" : "Suggest fixes for a SQL query.",
+ "description" : "Get information about a given document.",
+ "operationId" : "post-api-ee-metabot-tools-get-document-details",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "error_message" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-document-details-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"type" : "string"
},
- "query" : {
- "properties" : {
- "database" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "database" ],
- "type" : "object"
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "query", "error_message" ],
+ "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -21300,7 +28369,30 @@
},
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21309,30 +28401,38 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/ai-sql-fixer/fix",
- "tags" : [ "/api/ee/ai-sql-fixer" ]
+ "summary" : "POST /api/ee/metabot-tools/get-document-details",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/ai-sql-generation/generate" : {
+ "/api/ee/metabot-tools/get-metric-details" : {
"post" : {
- "description" : "Generate a SQL query.",
+ "description" : "Get information about a given metric.",
+ "operationId" : "post-api-ee-metabot-tools-get-metric-details",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "database_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-metric-details-arguments"
},
- "prompt" : {
- "minLength" : 1,
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "prompt", "database_id" ],
+ "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -21340,7 +28440,30 @@
},
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21349,28 +28472,69 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/ai-sql-generation/generate",
- "tags" : [ "/api/ee/ai-sql-generation" ]
+ "summary" : "POST /api/ee/metabot-tools/get-metric-details",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/audit-app/analytics-dev/export" : {
+ "/api/ee/metabot-tools/get-query-details" : {
"post" : {
- "description" : "Export analytics content as a .tar.gz file for local development.\n\n Only available when MB_ANALYTICS_DEV_MODE=true. Returns a tarball containing\n the analytics YAMLs in canonical format, ready to commit to source control.\n\n Requires superuser permissions.",
+ "description" : "Get information about a given query.",
+ "operationId" : "post-api-ee-metabot-tools-get-query-details",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-query-details-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "body" : { }
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "required" : [ "body" ],
+ "required" : [ "conversation_id" ],
"type" : "object"
}
}
},
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21379,45 +28543,69 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/audit-app/analytics-dev/export",
- "tags" : [ "/api/ee/audit-app/analytics-dev" ]
+ "summary" : "POST /api/ee/metabot-tools/get-query-details",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/audit-app/user/audit-info" : {
- "get" : {
- "description" : "Gets audit info for the current user if he has permissions to access the audit collection.\n Otherwise return an empty map.",
+ "/api/ee/metabot-tools/get-report-details" : {
+ "post" : {
+ "description" : "Get information about a given report.",
+ "operationId" : "post-api-ee-metabot-tools-get-report-details",
"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.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-report-details-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
+ }
+ }
}
},
- "summary" : "GET /api/ee/audit-app/user/audit-info",
- "tags" : [ "/api/ee/audit-app/user" ]
- }
- },
- "/api/ee/audit-app/user/{id}/subscriptions" : {
- "delete" : {
- "description" : "Delete all Alert and DashboardSubscription subscriptions for a User (i.e., so they will no longer receive them).\n Archive all Alerts and DashboardSubscriptions created by the User. Only allowed for admins or for the current user.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21426,104 +28614,38 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/audit-app/user/{id}/subscriptions",
- "tags" : [ "/api/ee/audit-app/user" ]
+ "summary" : "POST /api/ee/metabot-tools/get-report-details",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/autodescribe/card/summarize" : {
+ "/api/ee/metabot-tools/get-snippet-details" : {
"post" : {
- "description" : "Summarize a question.",
+ "description" : "Get the content of a single SQL snippet.",
+ "operationId" : "post-api-ee-metabot-tools-get-snippet-details",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "cache_ttl" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "collection_position" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "dataset" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "dataset_query" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "description" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-snippet-details-arguments"
},
- "display" : {
- "minLength" : 1,
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"type" : "string"
},
- "parameter_mappings" : {
- "oneOf" : [ {
- "items" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter-mapping"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "parameters" : {
- "oneOf" : [ {
- "items" : {
- "$ref" : "#/components/schemas/metabase.parameters.schema.parameter"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "result_metadata" : {
+ "profile_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.analyze.query-results.ResultsMetadata"
- }, {
- "type" : "null"
- } ]
- },
- "visualization_settings" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "dataset_query", "display", "visualization_settings" ],
+ "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -21531,7 +28653,33 @@
},
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "structured_output" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.full-snippet"
+ }
+ },
+ "required" : [ "structured_output", "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21540,26 +28688,56 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/autodescribe/card/summarize",
- "tags" : [ "/api/ee/autodescribe" ]
+ "summary" : "POST /api/ee/metabot-tools/get-snippet-details",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/autodescribe/dashboard/summarize/{id}" : {
+ "/api/ee/metabot-tools/get-snippets" : {
"post" : {
- "description" : "Provide a summary of a dashboard.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "description" : "Get a list of all known SQL snippets.",
+ "operationId" : "post-api-ee-metabot-tools-get-snippets",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "structured_output" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.basic-snippet"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "structured_output", "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21568,36 +28746,69 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/autodescribe/dashboard/summarize/{id}",
- "tags" : [ "/api/ee/autodescribe" ]
+ "summary" : "POST /api/ee/metabot-tools/get-snippets",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/billing/" : {
- "get" : {
- "description" : "Get billing information. This acts as a proxy between `metabase-billing-info-url` and the client,\n using the embedding token and signed in user's email to fetch the billing information.",
+ "/api/ee/metabot-tools/get-table-details" : {
+ "post" : {
+ "description" : "Get information about a given table or model.",
+ "operationId" : "post-api-ee-metabot-tools-get-table-details",
"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.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-table-details-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
+ }
+ }
}
},
- "summary" : "GET /api/ee/billing/",
- "tags" : [ "/api/ee/billing" ]
- }
- },
- "/api/ee/cloud-add-ons/addons" : {
- "get" : {
- "description" : "Get addons information from the Metabase Store API.",
- "parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21606,17 +28817,69 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/cloud-add-ons/addons",
- "tags" : [ "/api/ee/cloud-add-ons" ]
+ "summary" : "POST /api/ee/metabot-tools/get-table-details",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/cloud-add-ons/plans" : {
- "get" : {
- "description" : "Get plans information from the Metabase Store API.",
+ "/api/ee/metabot-tools/get-tables" : {
+ "post" : {
+ "description" : "Get information about the tables in a given database.",
+ "operationId" : "post-api-ee-metabot-tools-get-tables",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-tables-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21625,42 +28888,38 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/cloud-add-ons/plans",
- "tags" : [ "/api/ee/cloud-add-ons" ]
+ "summary" : "POST /api/ee/metabot-tools/get-tables",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/cloud-add-ons/{product-type}" : {
+ "/api/ee/metabot-tools/get-transform-details" : {
"post" : {
- "description" : "Purchase an add-on.",
- "parameters" : [ {
- "in" : "path",
- "name" : "product-type",
- "required" : true,
- "schema" : {
- "enum" : [ "metabase-ai", "metabase-ai-tiered", "python-execution" ],
- "type" : "string"
- }
- } ],
+ "description" : "Get information about a transform.",
+ "operationId" : "post-api-ee-metabot-tools-get-transform-details",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "quantity" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-transform-details-arguments"
},
- "terms_of_service" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
}
},
+ "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -21668,7 +28927,30 @@
},
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21677,17 +28959,69 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/cloud-add-ons/{product-type}",
- "tags" : [ "/api/ee/cloud-add-ons" ]
+ "summary" : "POST /api/ee/metabot-tools/get-transform-details",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/content-translation/csv" : {
- "get" : {
- "description" : "Provides content translation dictionary in CSV",
+ "/api/ee/metabot-tools/get-transform-python-library-details" : {
+ "post" : {
+ "description" : "Get information about a Python library by path.",
+ "operationId" : "post-api-ee-metabot-tools-get-transform-python-library-details",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "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.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21696,54 +29030,50 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/content-translation/csv",
- "tags" : [ "/api/ee/content-translation" ]
+ "summary" : "POST /api/ee/metabot-tools/get-transform-python-library-details",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/content-translation/dictionary" : {
- "get" : {
- "description" : "Fetch the content translation dictionary for authenticated users (auth-based embedding flows).",
- "parameters" : [ {
- "in" : "query",
- "name" : "locale",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "/api/ee/metabot-tools/get-transforms" : {
+ "post" : {
+ "description" : "Get a list of all known transforms.",
+ "operationId" : "post-api-ee-metabot-tools-get-transforms",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "data" : {
- "items" : {
- "properties" : {
- "locale" : {
- "minLength" : 1,
- "type" : "string"
- },
- "msgid" : {
- "minLength" : 1,
- "type" : "string"
- },
- "msgstr" : {
- "type" : "string"
- }
- },
- "required" : [ "locale", "msgid", "msgstr" ],
- "type" : "object"
- },
- "type" : "array"
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "data" ],
+ "required" : [ "conversation_id" ],
"type" : "object"
}
}
},
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21752,25 +29082,69 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/content-translation/dictionary",
- "tags" : [ "/api/ee/content-translation" ]
+ "summary" : "POST /api/ee/metabot-tools/get-transforms",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/content-translation/dictionary/{token}" : {
- "get" : {
- "description" : "Fetch the content translation dictionary via a JSON Web Token signed with the `embedding-secret-key`.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
+ "/api/ee/metabot-tools/query-datasource" : {
+ "post" : {
+ "description" : "Construct a query from a model or table data source.",
+ "operationId" : "post-api-ee-metabot-tools-query-datasource",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.query-datasource-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21779,31 +29153,38 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/content-translation/dictionary/{token}",
- "tags" : [ "/api/ee/content-translation" ]
+ "summary" : "POST /api/ee/metabot-tools/query-datasource",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/content-translation/upload-dictionary" : {
+ "/api/ee/metabot-tools/query-metric" : {
"post" : {
- "description" : "Upload a CSV of content translations",
+ "description" : "Construct a query from a metric.",
+ "operationId" : "post-api-ee-metabot-tools-query-metric",
"parameters" : [ ],
"requestBody" : {
"content" : {
- "multipart/form-data" : {
+ "application/json" : {
"schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "file" : {
- "properties" : {
- "filename" : {
- "type" : "string"
- },
- "tempfile" : { }
- },
- "required" : [ "filename", "tempfile" ],
- "type" : "object"
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.query-metric-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "file" ],
+ "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -21811,7 +29192,30 @@
},
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21820,19 +29224,39 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/content-translation/upload-dictionary",
- "tags" : [ "/api/ee/content-translation" ]
+ "summary" : "POST /api/ee/metabot-tools/query-metric",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/data-studio/table/discard-values" : {
+ "/api/ee/metabot-tools/query-model" : {
"post" : {
- "description" : "Batch version of /table/:id/discard_values. Takes an abstract table selection as /table/edit does.",
+ "description" : "Construct a query from a model.",
+ "operationId" : "post-api-ee-metabot-tools-query-model",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.query-model-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "arguments", "conversation_id" ],
+ "type" : "object"
}
}
}
@@ -21842,11 +29266,27 @@
"content" : {
"application/json" : {
"schema" : {
- "type" : "null"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
}
}
},
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21855,85 +29295,38 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/data-studio/table/discard-values",
- "tags" : [ "/api/ee/data-studio/table" ]
+ "summary" : "POST /api/ee/metabot-tools/query-model",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/data-studio/table/edit" : {
+ "/api/ee/metabot-tools/search" : {
"post" : {
- "description" : "Bulk updating tables.",
+ "description" : "Enhanced search with term and semantic queries using Reciprocal Rank Fusion.",
+ "operationId" : "post-api-ee-metabot-tools-search",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "additionalProperties" : false,
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "data_authority" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-authorities"
- }, {
- "type" : "null"
- } ]
- },
- "data_layer" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-layers"
- }, {
- "type" : "null"
- } ]
- },
- "data_source" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-sources"
- }, {
- "type" : "null"
- } ]
- },
- "database_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.search-arguments"
},
- "entity_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
},
- "owner_email" : {
+ "profile_id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
- },
- "owner_user_id" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "schema_ids" : {
- "items" : {
- "type" : "string"
- },
- "type" : "array"
- },
- "table_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
}
},
+ "required" : [ "conversation_id" ],
"type" : "object"
}
}
@@ -21944,13 +29337,27 @@
"content" : {
"application/json" : {
"schema" : {
- "additionalProperties" : false,
- "properties" : { },
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
"type" : "object"
}
}
},
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21959,19 +29366,39 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/data-studio/table/edit",
- "tags" : [ "/api/ee/data-studio/table" ]
+ "summary" : "POST /api/ee/metabot-tools/search",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/data-studio/table/publish-tables" : {
+ "/api/ee/metabot-tools/search_v2" : {
"post" : {
- "description" : "Set collection for each of selected tables and all upstream dependencies recursively.",
+ "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.",
+ "operationId" : "post-api-ee-metabot-tools-search_v2",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "arguments" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.search-arguments"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
}
}
}
@@ -21981,11 +29408,27 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.publish-tables-response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "properties" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "profile_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "conversation_id" ],
+ "type" : "object"
}
}
},
- "description" : "Successful response"
+ "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
},
"4XX" : {
"description" : "Client error response"
@@ -21994,32 +29437,58 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/data-studio/table/publish-tables",
- "tags" : [ "/api/ee/data-studio/table" ]
+ "summary" : "POST /api/ee/metabot-tools/search_v2",
+ "tags" : [ "/api/ee/metabot-tools" ]
}
},
- "/api/ee/data-studio/table/rescan-values" : {
+ "/api/ee/metabot-v3/agent-streaming" : {
"post" : {
- "description" : "Batch version of /table/:id/rescan_values. Takes an abstract table selection as /table/edit does.",
+ "description" : "Send a chat message to the LLM via the AI Proxy.",
+ "operationId" : "post-api-ee-metabot-v3-agent-streaming",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ "properties" : {
+ "context" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.context.context"
+ },
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ },
+ "history" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.client.schema.messages"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "metabot_id" : {
+ "type" : "string"
+ },
+ "profile_id" : {
+ "type" : "string"
+ },
+ "state" : {
+ "properties" : { },
+ "type" : "object"
+ }
+ },
+ "required" : [ "message", "context", "conversation_id", "history", "state" ],
+ "type" : "object"
}
}
}
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "null"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -22029,32 +29498,38 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/data-studio/table/rescan-values",
- "tags" : [ "/api/ee/data-studio/table" ]
+ "summary" : "POST /api/ee/metabot-v3/agent-streaming",
+ "tags" : [ "/api/ee/metabot-v3" ]
}
},
- "/api/ee/data-studio/table/selection" : {
+ "/api/ee/metabot-v3/document/generate-content" : {
"post" : {
- "description" : "Gets information about selected tables",
+ "description" : "Create a new piece of content to insert into the document.",
+ "operationId" : "post-api-ee-metabot-v3-document-generate-content",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ "properties" : {
+ "instructions" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "references" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ }
+ },
+ "required" : [ "instructions" ],
+ "type" : "object"
}
}
}
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.bulk-table-selection-info"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -22064,32 +29539,27 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/data-studio/table/selection",
- "tags" : [ "/api/ee/data-studio/table" ]
+ "summary" : "POST /api/ee/metabot-v3/document/generate-content",
+ "tags" : [ "/api/ee/metabot-v3/document" ]
}
},
- "/api/ee/data-studio/table/sync-schema" : {
+ "/api/ee/metabot-v3/feedback" : {
"post" : {
- "description" : "Batch version of /table/:id/sync_schema. Takes an abstract table selection as /table/edit does.\n - Currently checks policy before returning (so you might receive a 4xx on e.g. AuthZ policy failure)\n - The sync itself is however, asynchronous. This call may return before all tables synced.",
+ "description" : "Proxy Metabot feedback to Harbormaster, adding the premium embedding token.",
+ "operationId" : "post-api-ee-metabot-v3-feedback",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ "properties" : { },
+ "type" : "object"
}
}
}
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "null"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -22099,32 +29569,17 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/data-studio/table/sync-schema",
- "tags" : [ "/api/ee/data-studio/table" ]
+ "summary" : "POST /api/ee/metabot-v3/feedback",
+ "tags" : [ "/api/ee/metabot-v3" ]
}
},
- "/api/ee/data-studio/table/unpublish-tables" : {
- "post" : {
- "description" : "Unset collection for each of selected tables and all downstream dependents recursively.",
+ "/api/ee/metabot-v3/metabot" : {
+ "get" : {
+ "description" : "List configured metabot instances",
+ "operationId" : "get-api-ee-metabot-v3-metabot",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
- }
- }
- }
- },
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "null"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -22134,17 +29589,17 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/data-studio/table/unpublish-tables",
- "tags" : [ "/api/ee/data-studio/table" ]
+ "summary" : "GET /api/ee/metabot-v3/metabot",
+ "tags" : [ "/api/ee/metabot-v3/metabot" ]
}
},
- "/api/ee/database-replication/connection/{database-id}" : {
- "delete" : {
- "description" : "Delete PG replication connection for the specified database.",
+ "/api/ee/metabot-v3/metabot/{id}" : {
+ "get" : {
+ "description" : "Retrieve one metabot instance",
+ "operationId" : "get-api-ee-metabot-v3-metabot-id",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "database-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -22162,15 +29617,15 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/database-replication/connection/{database-id}",
- "tags" : [ "/api/ee/database-replication" ]
+ "summary" : "GET /api/ee/metabot-v3/metabot/{id}",
+ "tags" : [ "/api/ee/metabot-v3/metabot" ]
},
- "post" : {
- "description" : "Create a new PG replication connection for the specified database.",
+ "put" : {
+ "description" : "Update a metabot instance",
+ "operationId" : "put-api-ee-metabot-v3-metabot-id",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "database-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -22181,19 +29636,18 @@
"content" : {
"application/json" : {
"schema" : {
+ "additionalProperties" : false,
"properties" : {
- "replicationSchemaFilters" : {
- "properties" : {
- "schema-filters-patterns" : {
- "type" : "string"
- },
- "schema-filters-type" : {
- "enum" : [ "inclusion", "exclusion", "all" ],
- "type" : "string"
- }
- },
- "required" : [ "schema-filters-type", "schema-filters-patterns" ],
- "type" : "object"
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "use_verified_content" : {
+ "type" : "boolean"
}
},
"type" : "object"
@@ -22212,47 +29666,23 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/database-replication/connection/{database-id}",
- "tags" : [ "/api/ee/database-replication" ]
+ "summary" : "PUT /api/ee/metabot-v3/metabot/{id}",
+ "tags" : [ "/api/ee/metabot-v3/metabot" ]
}
},
- "/api/ee/database-replication/connection/{database-id}/preview" : {
- "post" : {
- "description" : "Return info about pg-replication connection that is about to be created.",
+ "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions" : {
+ "delete" : {
+ "description" : "Delete all prompt suggestions for the metabot instance with `id`.",
+ "operationId" : "delete-api-ee-metabot-v3-metabot-id-prompt-suggestions",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "database-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "replicationSchemaFilters" : {
- "properties" : {
- "schema-filters-patterns" : {
- "type" : "string"
- },
- "schema-filters-type" : {
- "enum" : [ "inclusion", "exclusion", "all" ],
- "type" : "string"
- }
- },
- "required" : [ "schema-filters-type", "schema-filters-patterns" ],
- "type" : "object"
- }
- },
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -22264,56 +29694,72 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/database-replication/connection/{database-id}/preview",
- "tags" : [ "/api/ee/database-replication" ]
- }
- },
- "/api/ee/database-routing/destination-database" : {
- "post" : {
- "description" : "Create new Destination Databases.\n\n Note that unlike the normal `POST /api/database` endpoint, does NOT check the details before adding the Database.\n\n This is OK, it's not an invariant that all database details are always valid, but it's something to note.",
+ "summary" : "DELETE /api/ee/metabot-v3/metabot/{id}/prompt-suggestions",
+ "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ },
+ "get" : {
+ "description" : "Return the prompt suggestions for the metabot instance with `id`.",
+ "operationId" : "get-api-ee-metabot-v3-metabot-id-prompt-suggestions",
"parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
"in" : "query",
- "name" : "check_connection_details",
+ "name" : "sample",
"required" : false,
"schema" : {
"type" : "boolean"
}
+ }, {
+ "in" : "query",
+ "name" : "model",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "metric", "model" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "model_id",
+ "required" : false,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "destinations" : {
- "items" : {
- "properties" : {
- "details" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "name", "details" ],
- "type" : "object"
- },
- "type" : "array"
- },
- "router_database_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "router_database_id", "destinations" ],
- "type" : "object"
- }
- }
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/ee/metabot-v3/metabot/{id}/prompt-suggestions",
+ "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ }
+ },
+ "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/regenerate" : {
+ "post" : {
+ "description" : "Remove any existing prompt suggestions for the Metabot instance with `id` and generate new ones.",
+ "operationId" : "post-api-ee-metabot-v3-metabot-id-prompt-suggestions-regenerate",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -22325,15 +29771,15 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/database-routing/destination-database",
- "tags" : [ "/api/ee/database-routing" ]
+ "summary" : "POST /api/ee/metabot-v3/metabot/{id}/prompt-suggestions/regenerate",
+ "tags" : [ "/api/ee/metabot-v3/metabot" ]
}
},
- "/api/ee/database-routing/router-database/{id}" : {
- "put" : {
- "description" : "Updates an existing Database with the `user_attribute` to route on. Will either:\n - turn an existing Database into a Router database\n - change the `user_attribute` used to route for an existing Router database, or\n - turn a Router database into a regular Database\n depending on the value of `user_attribute`",
+ "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}" : {
+ "delete" : {
+ "description" : "Delete the prompt suggestion with ID `prompt-id` for the metabot instance with `id`.",
+ "operationId" : "delete-api-ee-metabot-v3-metabot-id-prompt-suggestions-prompt-id",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "id",
"required" : true,
@@ -22341,26 +29787,15 @@
"minimum" : 1,
"type" : "integer"
}
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "user_attribute" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
+ }, {
+ "in" : "path",
+ "name" : "prompt-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -22372,29 +29807,80 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/database-routing/router-database/{id}",
- "tags" : [ "/api/ee/database-routing" ]
+ "summary" : "DELETE /api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}",
+ "tags" : [ "/api/ee/metabot-v3/metabot" ]
}
},
- "/api/ee/dependencies/check_card" : {
- "post" : {
- "description" : "Check a proposed edit to a card, and return the card IDs for those cards this edit will break.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.card-body"
+ "/api/ee/permission_debug" : {
+ "get" : {
+ "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-permission_debug",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "user_id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "model_id",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "action_type",
+ "required" : true,
+ "schema" : {
+ "enum" : [ "card/read", "card/query", "card/download-data" ],
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.permission-debug.impl.perm-debug-info"
+ }
}
- }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/ee/permission_debug",
+ "tags" : [ "/api/ee/permission_debug" ]
+ }
+ },
+ "/api/ee/remote-sync/branches" : {
+ "get" : {
+ "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.",
+ "operationId" : "get-api-ee-remote-sync-branches",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.broken-cards-response"
+ "properties" : {
+ "items" : {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "items" ],
+ "type" : "object"
}
}
},
@@ -22407,30 +29893,26 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/dependencies/check_card",
- "tags" : [ "/api/ee/dependencies" ]
+ "summary" : "GET /api/ee/remote-sync/branches",
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/dependencies/check_snippet" : {
+ "/api/ee/remote-sync/create-branch" : {
"post" : {
- "description" : "Check a proposed edit to a native snippet, and return the cards, etc. which will be broken.",
+ "description" : "Create a new branch from the current remote-sync branch and switches the current remote-sync branch to it.\n Requires superuser permissions.",
+ "operationId" : "post-api-ee-remote-sync-create-branch",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "content" : {
- "type" : "string"
- },
- "id" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
- },
"name" : {
- "description" : "snippet names cannot include '}' or start with spaces"
+ "minLength" : 1,
+ "type" : "string"
}
},
- "required" : [ "id" ],
+ "required" : [ "name" ],
"type" : "object"
}
}
@@ -22441,7 +29923,16 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.broken-cards-response"
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "status", "message" ],
+ "type" : "object"
}
}
},
@@ -22454,29 +29945,99 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/dependencies/check_snippet",
- "tags" : [ "/api/ee/dependencies" ]
+ "summary" : "POST /api/ee/remote-sync/create-branch",
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/dependencies/check_transform" : {
- "post" : {
- "description" : "Check a proposed edit to a transform, and return the card, transform, etc. IDs for things that will break.",
+ "/api/ee/remote-sync/current-task" : {
+ "get" : {
+ "description" : "Get the current sync task",
+ "operationId" : "get-api-ee-remote-sync-current-task",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.transform-body"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.broken-cards-response"
+ "oneOf" : [ {
+ "properties" : {
+ "cancelled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "conflicts" : {
+ "oneOf" : [ {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ended_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "error_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "initiated_by" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_progress_report_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "progress" : {
+ "oneOf" : [ {
+ "maximum" : 1.0,
+ "minimum" : 0.0,
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "started_at" : { },
+ "status" : {
+ "enum" : [ "running", "successful", "errored", "cancelled", "timed-out", "conflict" ],
+ "type" : "string"
+ },
+ "sync_task_type" : {
+ "enum" : [ "import", "export" ],
+ "type" : "string"
+ },
+ "version" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "sync_task_type", "progress", "started_at", "status" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
}
}
},
@@ -22489,43 +30050,95 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/dependencies/check_transform",
- "tags" : [ "/api/ee/dependencies" ]
+ "summary" : "GET /api/ee/remote-sync/current-task",
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/dependencies/graph" : {
- "get" : {
- "description" : "This endpoint takes an :id and a supported entity :type, and returns a graph of all its upstream dependencies.\n The graph is represented by a list of :nodes and a list of :edges. Each node has an :id, :type, :data (which\n depends on the node type), and a map of :dependent_counts per entity type. Each edge is a :model/Dependency.\n\n Optional :archived parameter controls whether entities in archived collections are included:\n - false (default): Excludes entities in archived collections\n - true: Includes entities in archived collections",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "query",
- "name" : "id",
- "required" : false,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "type",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- }
- }, {
- "in" : "query",
- "name" : "archived",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
- } ],
+ "/api/ee/remote-sync/current-task/cancel" : {
+ "post" : {
+ "description" : "Cancels the current task if one is running",
+ "operationId" : "post-api-ee-remote-sync-current-task-cancel",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.graph-response"
+ "properties" : {
+ "cancelled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "conflicts" : {
+ "oneOf" : [ {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ended_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "error_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "initiated_by" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_progress_report_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "progress" : {
+ "oneOf" : [ {
+ "maximum" : 1.0,
+ "minimum" : 0.0,
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "started_at" : { },
+ "status" : {
+ "enum" : [ "running", "successful", "errored", "cancelled", "timed-out", "conflict" ],
+ "type" : "string"
+ },
+ "sync_task_type" : {
+ "enum" : [ "import", "export" ],
+ "type" : "string"
+ },
+ "version" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "sync_task_type", "progress", "started_at", "status" ],
+ "type" : "object"
}
}
},
@@ -22538,108 +30151,142 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/dependencies/graph",
- "tags" : [ "/api/ee/dependencies" ]
+ "summary" : "POST /api/ee/remote-sync/current-task/cancel",
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/dependencies/graph/broken" : {
+ "/api/ee/remote-sync/dirty" : {
"get" : {
- "description" : "Returns a list of all items with broken queries.\n\n Accepts optional parameters for filtering:\n - `types`: List of entity types to include (e.g., `[:card :transform :snippet :dashboard]`)\n - `card_types`: List of card types to include when filtering cards (e.g., `[:question :model :metric]`)\n - `query`: Search string to filter by name or location\n - `archived`: Controls whether archived entities are included\n - `include_personal_collections`: Controls whether items in personal collections are included (default: false)\n - `sort_column`: Sort column - `:name`, `:location`, or `:dependents-count` (default: `:name`)\n - `sort_direction`: Sort direction - `:asc` or `:desc` (default: `:asc`)\n - `offset`: Default 0\n - `limit`: Default 50\n\n Returns a map with:\n - `data`: List of broken items, each with `:id`, `:type`, `:data`, and `:error`s fields\n - `total`: Total count of matched items\n - `offset`: Applied offset\n - `limit`: Applied limit",
- "parameters" : [ {
- "in" : "query",
- "name" : "types",
- "required" : false,
- "schema" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- }, {
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- },
- "type" : "array"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "card_types",
- "required" : false,
- "schema" : {
- "anyOf" : [ {
- "enum" : [ "question", "metric", "model" ],
- "type" : "string"
- }, {
- "items" : {
- "enum" : [ "question", "metric", "model" ],
- "type" : "string"
- },
- "type" : "array"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "query",
- "required" : false,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "archived",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "include_personal_collections",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "sort_column",
- "required" : false,
- "schema" : {
- "enum" : [ "name", "location", "dependents-count" ],
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "sort_direction",
- "required" : false,
- "schema" : {
- "enum" : [ "desc", "asc" ],
- "type" : "string"
+ "description" : "Return all models with changes that have not been pushed to the remote sync source in any\n remote-synced collection.",
+ "operationId" : "get-api-ee-remote-sync-dirty",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "dirty" : {
+ "items" : {
+ "properties" : {
+ "authority_level" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "model" : {
+ "type" : "string"
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "query_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "sync_status" : {
+ "type" : "string"
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "model", "sync_status" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "dirty" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- } ],
+ },
+ "summary" : "GET /api/ee/remote-sync/dirty",
+ "tags" : [ "/api/ee/remote-sync" ]
+ }
+ },
+ "/api/ee/remote-sync/export" : {
+ "post" : {
+ "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.",
+ "operationId" : "post-api-ee-remote-sync-export",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "data" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
- },
- "type" : "array"
+ "message" : {
+ "type" : "string"
},
- "limit" : {
- "description" : "value must be an integer greater than zero.",
+ "task_id" : {
"minimum" : 1,
"type" : "integer"
- },
- "offset" : {
- "minimum" : 0,
- "type" : "integer"
- },
- "total" : {
- "minimum" : 0,
- "type" : "integer"
}
},
- "required" : [ "data", "total", "offset", "limit" ],
+ "required" : [ "message", "task_id" ],
"type" : "object"
}
}
@@ -22653,47 +30300,17 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/dependencies/graph/broken",
- "tags" : [ "/api/ee/dependencies" ]
+ "summary" : "POST /api/ee/remote-sync/export",
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/dependencies/graph/dependents" : {
+ "/api/ee/remote-sync/has-remote-changes" : {
"get" : {
- "description" : "This endpoint takes an :id, :type, :dependent_type, and an optional :dependent_card_type, and returns a list of\n all that entity's dependents with :dependent_type. If the :dependent_type is :card, the dependents are further\n filtered by :dependent_card_type.\n\n Optional :archived parameter controls whether entities in archived collections are included:\n - false (default): Excludes entities in archived collections\n - true: Includes entities in archived collections",
+ "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-remote-sync-has-remote-changes",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "query",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "type",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- }
- }, {
- "in" : "query",
- "name" : "dependent_type",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- }
- }, {
- "in" : "query",
- "name" : "dependent_card_type",
- "required" : false,
- "schema" : {
- "enum" : [ "question", "metric", "model" ],
- "type" : "string"
- }
- }, {
"in" : "query",
- "name" : "archived",
+ "name" : "force-refresh",
"required" : false,
"schema" : {
"type" : "boolean"
@@ -22704,10 +30321,30 @@
"content" : {
"application/json" : {
"schema" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
+ "properties" : {
+ "cached" : {
+ "type" : "boolean"
+ },
+ "has_changes" : {
+ "type" : "boolean"
+ },
+ "local_version" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "remote_version" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "type" : "array"
+ "required" : [ "has_changes", "remote_version", "local_version", "cached" ],
+ "type" : "object"
}
}
},
@@ -22720,108 +30357,59 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/dependencies/graph/dependents",
- "tags" : [ "/api/ee/dependencies" ]
+ "summary" : "GET /api/ee/remote-sync/has-remote-changes",
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/dependencies/graph/unreferenced" : {
- "get" : {
- "description" : "Returns a list of all unreferenced items in the instance.\n An unreferenced item is one that is not a dependency of any other item.\n\n Accepts optional parameters for filtering:\n - `types`: List of entity types to include (e.g., [:card :transform :snippet :dashboard])\n - `card_types`: List of card types to include when filtering cards (e.g., [:question :model :metric])\n - `query`: Search string to filter by name or location\n - `archived`: Controls whether archived entities are included\n - `include_personal_collections`: Controls whether items in personal collections are included (default: false)\n - `sort_column`: Sort column - `:name`, `:location`, or `:dependents-count` (default: `:name`)\n - `sort_direction`: Sort direction - `:asc` or `:desc` (default: `:asc`)\n - `offset`: Default 0\n - `limit`: Default 50\n\n Returns a map with:\n - `data`: List of unreferenced items, each with `:id`, `:type`, and `:data` fields\n - `total`: Total count of matched items\n - `offset`: Applied offset\n - `limit`: Applied limit",
- "parameters" : [ {
- "in" : "query",
- "name" : "types",
- "required" : false,
- "schema" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- }, {
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.dependency-types.dependency-types"
- },
- "type" : "array"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "card_types",
- "required" : false,
- "schema" : {
- "anyOf" : [ {
- "enum" : [ "question", "metric", "model" ],
- "type" : "string"
- }, {
- "items" : {
- "enum" : [ "question", "metric", "model" ],
- "type" : "string"
- },
- "type" : "array"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "query",
- "required" : false,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "archived",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "include_personal_collections",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "sort_column",
- "required" : false,
- "schema" : {
- "enum" : [ "name", "location", "dependents-count" ],
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "sort_direction",
- "required" : false,
- "schema" : {
- "enum" : [ "desc", "asc" ],
- "type" : "string"
+ "/api/ee/remote-sync/import" : {
+ "post" : {
+ "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.",
+ "operationId" : "post-api-ee-remote-sync-import",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "branch" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "force" : {
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "data" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.dependencies.api.entity"
- },
- "type" : "array"
- },
- "limit" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "offset" : {
- "minimum" : 0,
- "type" : "integer"
+ "status" : {
+ "const" : "success"
},
- "total" : {
- "minimum" : 0,
- "type" : "integer"
+ "task_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "data", "total", "offset", "limit" ],
+ "required" : [ "status", "task_id" ],
"type" : "object"
}
}
@@ -22835,16 +30423,30 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/dependencies/graph/unreferenced",
- "tags" : [ "/api/ee/dependencies" ]
+ "summary" : "POST /api/ee/remote-sync/import",
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/email/override" : {
- "delete" : {
- "description" : "Clear all cloud email related settings. You must be a superuser or have `setting` permission to do this.",
+ "/api/ee/remote-sync/is-dirty" : {
+ "get" : {
+ "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-remote-sync-is-dirty",
"parameters" : [ ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "is_dirty" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "is_dirty" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -22854,47 +30456,68 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/email/override",
- "tags" : [ "/api/ee/email" ]
- },
+ "summary" : "GET /api/ee/remote-sync/is-dirty",
+ "tags" : [ "/api/ee/remote-sync" ]
+ }
+ },
+ "/api/ee/remote-sync/settings" : {
"put" : {
- "description" : "Update multiple cloud email Settings. You must be a superuser or have `setting` permission to do this.\n Calling this automatically sets `cloud-smtp-enabled` to true if the settings are valid.",
+ "description" : "Update Remote Sync related settings. You must be a superuser to do this.",
+ "operationId" : "put-api-ee-remote-sync-settings",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "email-smtp-host-override" : {
- "anyOf" : [ {
+ "collections" : {
+ "oneOf" : [ {
+ "additionalProperties" : {
+ "type" : "boolean"
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "remote-sync-auto-import" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "remote-sync-branch" : {
+ "oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "email-smtp-password-override" : {
- "anyOf" : [ {
+ "remote-sync-token" : {
+ "oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "email-smtp-port-override" : {
- "anyOf" : [ {
- "type" : "integer"
+ "remote-sync-transforms" : {
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "email-smtp-security-override" : {
- "anyOf" : [ {
+ "remote-sync-type" : {
+ "oneOf" : [ {
+ "enum" : [ "read-only", "read-write" ],
"type" : "string"
}, {
"type" : "null"
} ]
},
- "email-smtp-username-override" : {
- "anyOf" : [ {
+ "remote-sync-url" : {
+ "oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
@@ -22906,67 +30529,22 @@
}
}
},
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "PUT /api/ee/email/override",
- "tags" : [ "/api/ee/email" ]
- }
- },
- "/api/ee/embedding-hub/checklist" : {
- "get" : {
- "description" : "Get the embedding hub checklist status, indicating which setup steps have been completed.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/ee/embedding-hub/checklist",
- "tags" : [ "/api/ee/embedding-hub" ]
- }
- },
- "/api/ee/gsheets/connection" : {
- "delete" : {
- "description" : "Disconnect the google service account. There is only one (or zero) at the time of writing.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "DELETE /api/ee/gsheets/connection",
- "tags" : [ "/api/ee/gsheets" ]
- },
- "get" : {
- "description" : "Check the status of a connection. This endpoint gets polled by FE to determine when to\n stop showing the setup widget.\n\n Returns the gsheets shape, with the attached datawarehouse db id at `:db_id`.",
- "parameters" : [ ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/gsheets.response"
+ "properties" : {
+ "success" : {
+ "type" : "boolean"
+ },
+ "task_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "success" ],
+ "type" : "object"
}
}
},
@@ -22979,23 +30557,30 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/gsheets/connection",
- "tags" : [ "/api/ee/gsheets" ]
- },
+ "summary" : "PUT /api/ee/remote-sync/settings",
+ "tags" : [ "/api/ee/remote-sync" ]
+ }
+ },
+ "/api/ee/remote-sync/stash" : {
"post" : {
- "description" : "Hook up a new google drive folder or sheet that will be watched and have its content ETL'd into Metabase.",
+ "description" : "Stashes changes to a new branch, and changes the current branch to it.\n Requires superuser permissions.",
+ "operationId" : "post-api-ee-remote-sync-stash",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "url" : {
+ "message" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "new_branch" : {
"minLength" : 1,
"type" : "string"
}
},
- "required" : [ "url" ],
+ "required" : [ "new_branch", "message" ],
"type" : "object"
}
}
@@ -23006,7 +30591,20 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/gsheets.response"
+ "properties" : {
+ "message" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ },
+ "task_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "status", "message", "task_id" ],
+ "type" : "object"
}
}
},
@@ -23019,13 +30617,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/gsheets/connection",
- "tags" : [ "/api/ee/gsheets" ]
+ "summary" : "POST /api/ee/remote-sync/stash",
+ "tags" : [ "/api/ee/remote-sync" ]
}
},
- "/api/ee/gsheets/connection/sync" : {
- "post" : {
- "description" : "Force a sync of the connection now.\n\n Returns the gsheets shape, with the attached datawarehouse db id at `:db_id`.",
+ "/api/ee/scim/api_key" : {
+ "get" : {
+ "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.",
+ "operationId" : "get-api-ee-scim-api_key",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -23038,33 +30637,15 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/gsheets/connection/sync",
- "tags" : [ "/api/ee/gsheets" ]
- }
- },
- "/api/ee/gsheets/service-account" : {
- "get" : {
- "description" : "Checks to see if service-account is setup or not, delegates to HM only if we haven't set it from a metabase cluster\n before.",
+ "summary" : "GET /api/ee/scim/api_key",
+ "tags" : [ "/api/ee/scim" ]
+ },
+ "post" : {
+ "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.",
+ "operationId" : "post-api-ee-scim-api_key",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "email" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "email" ],
- "type" : "object"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -23074,48 +30655,115 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/gsheets/service-account",
- "tags" : [ "/api/ee/gsheets" ]
+ "summary" : "POST /api/ee/scim/api_key",
+ "tags" : [ "/api/ee/scim" ]
}
},
- "/api/ee/library/" : {
+ "/api/ee/scim/v2/Groups" : {
"get" : {
- "description" : "Get the Library. If no library exists, it doesn't fail but returns an empty response",
- "parameters" : [ ],
+ "description" : "Fetch a list of groups.",
+ "operationId" : "get-api-ee-scim-v2-Groups",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "startIndex",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "count",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "filter",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "anyOf" : [ {
- "$ref" : "#/components/schemas/metabase.collections.schema.CollectionItem"
- }, {
- "properties" : {
- "data" : {
- "type" : "null"
- }
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/ee/scim/v2/Groups",
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
+ "post" : {
+ "description" : "Create a single group, and populates it if necessary.",
+ "operationId" : "post-api-ee-scim-v2-Groups",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "displayName" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "id" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "members" : {
+ "items" : {
+ "properties" : {
+ "$ref" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "value" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "value" ],
+ "type" : "object"
},
- "required" : [ "data" ],
- "type" : "object"
- } ]
- }
+ "type" : "array"
+ },
+ "schemas" : {
+ "items" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "schemas", "displayName" ],
+ "type" : "object"
}
- },
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ }
}
},
- "summary" : "GET /api/ee/library/",
- "tags" : [ "/api/ee/library" ]
- },
- "post" : {
- "description" : "Creates the Library if it doesn't exist. Returns the created collection.\n\n Requires superuser permissions.",
- "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -23127,14 +30775,23 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/library/",
- "tags" : [ "/api/ee/library" ]
+ "summary" : "POST /api/ee/scim/v2/Groups",
+ "tags" : [ "/api/ee/scim/v2" ]
}
},
- "/api/ee/library/tree" : {
- "get" : {
- "description" : "This matches /api/collection/tree but only returns the library collection.",
- "parameters" : [ ],
+ "/api/ee/scim/v2/Groups/{id}" : {
+ "delete" : {
+ "description" : "Delete a group.",
+ "operationId" : "delete-api-ee-scim-v2-Groups-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -23146,20 +30803,18 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/library/tree",
- "tags" : [ "/api/ee/library" ]
- }
- },
- "/api/ee/logs/query_execution/{yyyy-mm}" : {
+ "summary" : "DELETE /api/ee/scim/v2/Groups/{id}",
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
"get" : {
- "description" : "Fetch rows for the month specified by `:yyyy-mm` from the query_execution logs table.\n Must be a superuser.",
+ "description" : "Fetch a single group.",
+ "operationId" : "get-api-ee-scim-v2-Groups-id",
"parameters" : [ {
- "description" : "Must be a string like 2020-04 or 2222-11.",
"in" : "path",
- "name" : "yyyy-mm",
+ "name" : "id",
"required" : true,
"schema" : {
- "pattern" : "\\d{4}-\\d{2}",
+ "minLength" : 1,
"type" : "string"
}
} ],
@@ -23174,37 +30829,52 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/logs/query_execution/{yyyy-mm}",
- "tags" : [ "/api/ee/logs" ]
- }
- },
- "/api/ee/metabot-tools/answer-sources" : {
- "post" : {
- "description" : "Return top level meta information about available information sources.",
+ "summary" : "GET /api/ee/scim/v2/Groups/{id}",
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
+ "put" : {
+ "description" : "Update a group.",
+ "operationId" : "put-api-ee-scim-v2-Groups-id",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.answer-sources-arguments"
+ "displayName" : {
+ "minLength" : 1,
+ "type" : "string"
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "id" : {
+ "minLength" : 1,
"type" : "string"
},
- "profile_id" : {
- "oneOf" : [ {
+ "members" : {
+ "items" : {
+ "properties" : {
+ "$ref" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "value" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "value" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "schemas" : {
+ "items" : {
+ "minLength" : 1,
"type" : "string"
- }, {
- "type" : "null"
- } ]
+ },
+ "type" : "array"
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "schemas", "displayName" ],
"type" : "object"
}
}
@@ -23212,30 +30882,7 @@
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23244,68 +30891,56 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/answer-sources",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "PUT /api/ee/scim/v2/Groups/{id}",
+ "tags" : [ "/api/ee/scim/v2" ]
}
},
- "/api/ee/metabot-tools/check-transform-dependencies" : {
- "post" : {
- "description" : "Check a proposed edit to a transform and return details of cards or transforms that would be broken by the change.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.check-transform-dependencies-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
+ "/api/ee/scim/v2/Users" : {
+ "get" : {
+ "description" : "Fetch a list of users.",
+ "operationId" : "get-api-ee-scim-v2-Users",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "startIndex",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
}
- },
+ }, {
+ "in" : "query",
+ "name" : "count",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "filter",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23314,110 +30949,99 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/check-transform-dependencies",
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/create-dashboard-subscription" : {
+ "summary" : "GET /api/ee/scim/v2/Users",
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
"post" : {
- "description" : "Create a dashboard subscription.",
+ "description" : "Create a single user.",
+ "operationId" : "post-api-ee-scim-v2-Users",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.create-dashboard-subscription-arguments"
+ "active" : {
+ "type" : "boolean"
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "emails" : {
+ "items" : {
+ "properties" : {
+ "primary" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "value" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "value" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "groups" : {
+ "items" : {
+ "properties" : {
+ "$ref" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "display" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "value" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "value", "display" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "id" : {
+ "minLength" : 1,
"type" : "string"
},
- "profile_id" : {
+ "locale" : {
"oneOf" : [ {
+ "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
} ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
+ },
+ "name" : {
+ "properties" : {
+ "familyName" : {
+ "type" : "string"
+ },
+ "givenName" : {
+ "type" : "string"
+ }
},
- "output" : {
+ "required" : [ "givenName", "familyName" ],
+ "type" : "object"
+ },
+ "schemas" : {
+ "items" : {
+ "minLength" : 1,
"type" : "string"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "output", "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/ee/metabot-tools/create-dashboard-subscription",
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/field-values" : {
- "post" : {
- "description" : "Return statistics and/or values for a given field of a given entity.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.field-values-arguments"
+ "type" : "array"
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "userName" : {
+ "minLength" : 1,
"type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
}
},
- "required" : [ "arguments", "conversation_id" ],
+ "required" : [ "schemas", "userName", "name", "emails" ],
"type" : "object"
}
}
@@ -23425,30 +31049,7 @@
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23457,68 +31058,26 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/field-values",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "POST /api/ee/scim/v2/Users",
+ "tags" : [ "/api/ee/scim/v2" ]
}
},
- "/api/ee/metabot-tools/filter-records" : {
- "post" : {
- "description" : "Construct a query from a metric.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.filter-records-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
+ "/api/ee/scim/v2/Users/{id}" : {
+ "get" : {
+ "description" : "Fetch a single user.",
+ "operationId" : "get-api-ee-scim-v2-Users-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
}
- },
+ } ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23526,38 +31085,67 @@
"5XX" : {
"description" : "Server error response"
}
- },
- "summary" : "POST /api/ee/metabot-tools/filter-records",
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/find-outliers" : {
- "post" : {
- "description" : "Find outliers in the values provided by a data source for a given column.",
- "parameters" : [ ],
+ },
+ "summary" : "GET /api/ee/scim/v2/Users/{id}",
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
+ "patch" : {
+ "description" : "Activate or deactivate a user. Supports specific replace operations, but not arbitrary patches.",
+ "operationId" : "patch-api-ee-scim-v2-Users-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.find-outliers-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
+ "Operations" : {
+ "items" : {
+ "properties" : {
+ "op" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "value" : {
+ "anyOf" : [ {
+ "additionalProperties" : {
+ "anyOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "boolean"
+ } ]
+ },
+ "type" : "object"
+ }, {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "boolean"
+ } ]
+ }
+ },
+ "required" : [ "op", "value" ],
+ "type" : "object"
+ },
+ "type" : "array"
},
- "profile_id" : {
- "oneOf" : [ {
+ "schemas" : {
+ "items" : {
+ "minLength" : 1,
"type" : "string"
- }, {
- "type" : "null"
- } ]
+ },
+ "type" : "array"
}
},
- "required" : [ "arguments", "conversation_id" ],
+ "required" : [ "schemas", "Operations" ],
"type" : "object"
}
}
@@ -23565,30 +31153,7 @@
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23597,37 +31162,99 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/find-outliers",
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/generate-insights" : {
- "post" : {
- "description" : "Generate insights.",
+ "summary" : "PATCH /api/ee/scim/v2/Users/{id}",
+ "tags" : [ "/api/ee/scim/v2" ]
+ },
+ "put" : {
+ "description" : "Update a user.",
+ "operationId" : "put-api-ee-scim-v2-Users-id",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.generate-insights-arguments"
+ "active" : {
+ "type" : "boolean"
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "emails" : {
+ "items" : {
+ "properties" : {
+ "primary" : {
+ "type" : "boolean"
+ },
+ "type" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "value" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "value" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "groups" : {
+ "items" : {
+ "properties" : {
+ "$ref" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "display" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "value" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "value", "display" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "id" : {
+ "minLength" : 1,
"type" : "string"
},
- "profile_id" : {
+ "locale" : {
"oneOf" : [ {
+ "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "name" : {
+ "properties" : {
+ "familyName" : {
+ "type" : "string"
+ },
+ "givenName" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "givenName", "familyName" ],
+ "type" : "object"
+ },
+ "schemas" : {
+ "items" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : "array"
+ },
+ "userName" : {
+ "minLength" : 1,
+ "type" : "string"
}
},
- "required" : [ "arguments", "conversation_id" ],
+ "required" : [ "schemas", "userName", "name", "emails" ],
"type" : "object"
}
}
@@ -23635,39 +31262,7 @@
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "output" : {
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "reactions" : {
- "items" : {
- "$ref" : "#/components/schemas/metabot.reaction.redirect"
- },
- "type" : "array"
- }
- },
- "required" : [ "output", "reactions", "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23676,49 +31271,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/generate-insights",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "PUT /api/ee/scim/v2/Users/{id}",
+ "tags" : [ "/api/ee/scim/v2" ]
}
},
- "/api/ee/metabot-tools/get-current-user" : {
- "post" : {
- "description" : "Get information about user that started the conversation.",
+ "/api/ee/semantic-search/status" : {
+ "get" : {
+ "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.",
+ "operationId" : "get-api-ee-semantic-search-status",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"
- }
- }
- }
- },
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23727,68 +31291,111 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-current-user",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "GET /api/ee/semantic-search/status",
+ "tags" : [ "/api/ee/semantic-search" ]
}
},
- "/api/ee/metabot-tools/get-dashboard-details" : {
+ "/api/ee/serialization/export" : {
"post" : {
- "description" : "Get information about a given dashboard.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-dashboard-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
+ "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.",
+ "operationId" : "post-api-ee-serialization-export",
+ "parameters" : [ {
+ "description" : "name of directory and archive file (default: `<instance-name>-<YYYY-MM-dd_HH-mm>`)",
+ "in" : "query",
+ "name" : "dirname",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
- },
+ }, {
+ "description" : "collections' db ids/entity-ids to serialize",
+ "in" : "query",
+ "name" : "collection",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "items" : {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "pattern" : "^.{21}$",
+ "type" : "string"
+ }, {
+ "pattern" : "^eid:.{21}$",
+ "type" : "string"
+ } ]
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "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",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ } ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23797,68 +31404,72 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-dashboard-details",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "POST /api/ee/serialization/export",
+ "tags" : [ "/api/ee/serialization" ]
}
},
- "/api/ee/metabot-tools/get-document-details" : {
+ "/api/ee/serialization/import" : {
"post" : {
- "description" : "Get information about a given document.",
- "parameters" : [ ],
+ "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-serialization-import",
+ "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",
+ "required" : true,
+ "schema" : {
+ "default" : true,
+ "type" : "boolean"
+ }
+ } ],
"requestBody" : {
"content" : {
- "application/json" : {
+ "multipart/form-data" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-document-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "file" : {
+ "additionalProperties" : false,
+ "description" : ".tgz with serialization data",
+ "properties" : {
+ "content-type" : {
+ "type" : "string"
+ },
+ "filename" : {
+ "type" : "string"
+ },
+ "size" : {
+ "type" : "integer"
+ },
+ "tempfile" : { }
+ },
+ "required" : [ "content-type", "filename", "size", "tempfile" ],
+ "type" : "object"
}
},
- "required" : [ "arguments", "conversation_id" ],
+ "required" : [ "file" ],
"type" : "object"
}
}
}
},
"responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "2XX" : {
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23867,68 +31478,68 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-document-details",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "POST /api/ee/serialization/import",
+ "tags" : [ "/api/ee/serialization" ]
}
},
- "/api/ee/metabot-tools/get-metric-details" : {
- "post" : {
- "description" : "Get information about a given metric.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-metric-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
+ "/api/ee/stale/{id}" : {
+ "get" : {
+ "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)",
+ "operationId" : "get-api-ee-stale-id",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "anyOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "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",
+ "enum" : [ "name", "last_used_at" ],
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "sort_direction",
+ "required" : true,
+ "schema" : {
+ "default" : "asc",
+ "enum" : [ "asc", "desc" ],
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -23937,68 +31548,60 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-metric-details",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "GET /api/ee/stale/{id}",
+ "tags" : [ "/api/ee/stale" ]
}
},
- "/api/ee/metabot-tools/get-query-details" : {
- "post" : {
- "description" : "Get information about a given query.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-query-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
+ "/api/ee/support-access-grant" : {
+ "get" : {
+ "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)",
+ "operationId" : "get-api-ee-support-access-grant",
+ "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.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include-revoked",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.list-grants-response"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24007,38 +31610,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-query-details",
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/get-report-details" : {
+ "summary" : "GET /api/ee/support-access-grant",
+ "tags" : [ "/api/ee/support-access-grant" ]
+ },
"post" : {
- "description" : "Get information about a given report.",
+ "description" : "Create a new support access grant.\n\n Requires superuser permissions. Only one active grant can exist at a time.",
+ "operationId" : "post-api-ee-support-access-grant",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-report-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.create-grant-request"
}
}
}
@@ -24048,27 +31631,11 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24077,71 +31644,25 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-report-details",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "POST /api/ee/support-access-grant",
+ "tags" : [ "/api/ee/support-access-grant" ]
}
},
- "/api/ee/metabot-tools/get-snippet-details" : {
- "post" : {
- "description" : "Get the content of a single SQL snippet.",
+ "/api/ee/support-access-grant/current" : {
+ "get" : {
+ "description" : "Get the currently active support access grant, if one exists.\n\n Requires superuser permissions.",
+ "operationId" : "get-api-ee-support-access-grant-current",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-snippet-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "structured_output" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.full-snippet"
- }
- },
- "required" : [ "structured_output", "conversation_id" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.current-grant-response"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24150,55 +31671,34 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-snippet-details",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "GET /api/ee/support-access-grant/current",
+ "tags" : [ "/api/ee/support-access-grant" ]
}
},
- "/api/ee/metabot-tools/get-snippets" : {
- "post" : {
- "description" : "Get a list of all known SQL snippets.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"
- }
- }
+ "/api/ee/support-access-grant/{id}/revoke" : {
+ "put" : {
+ "description" : "Revoke an existing support access grant.\n\n Requires superuser permissions. Any admin can revoke any grant.",
+ "operationId" : "put-api-ee-support-access-grant-id-revoke",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "structured_output" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.basic-snippet"
- },
- "type" : "array"
- }
- },
- "required" : [ "structured_output", "conversation_id" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24207,68 +31707,84 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-snippets",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "PUT /api/ee/support-access-grant/{id}/revoke",
+ "tags" : [ "/api/ee/support-access-grant" ]
}
},
- "/api/ee/metabot-tools/get-table-details" : {
- "post" : {
- "description" : "Get information about a given table or model.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-table-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
+ "/api/ee/tenant" : {
+ "get" : {
+ "description" : "Get all tenants",
+ "operationId" : "get-api-ee-tenant",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "status",
+ "required" : true,
+ "schema" : {
+ "default" : "all",
+ "enum" : [ "all", "deactivated", "active" ],
+ "type" : "string"
}
- },
+ } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "additionalProperties" : false,
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "data" : {
+ "items" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "attributes" : {
+ "oneOf" : [ {
+ "additionalProperties" : {
+ "type" : "string"
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "pattern" : "^[-_a-z0-9]{1,255}$",
+ "type" : "string"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
+ "type" : "object"
+ },
+ "type" : "array"
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "data" ],
"type" : "object"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24277,37 +31793,38 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-table-details",
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/get-tables" : {
+ "summary" : "GET /api/ee/tenant",
+ "tags" : [ "/api/ee/tenant" ]
+ },
"post" : {
- "description" : "Get information about the tables in a given database.",
+ "description" : "Create a new Tenant",
+ "operationId" : "post-api-ee-tenant",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "additionalProperties" : false,
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-tables-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
+ "attributes" : {
"oneOf" : [ {
- "type" : "string"
+ "additionalProperties" : { },
+ "type" : "object"
}, {
"type" : "null"
} ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "pattern" : "^[-_a-z0-9]{1,255}$",
+ "type" : "string"
}
},
- "required" : [ "arguments", "conversation_id" ],
+ "required" : [ "name", "slug" ],
"type" : "object"
}
}
@@ -24318,27 +31835,51 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "additionalProperties" : false,
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
+ "attributes" : {
"oneOf" : [ {
- "type" : "string"
+ "additionalProperties" : {
+ "type" : "string"
+ },
+ "type" : "object"
}, {
"type" : "null"
} ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "pattern" : "^[-_a-z0-9]{1,255}$",
+ "type" : "string"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
"type" : "object"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24347,68 +31888,74 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-tables",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "POST /api/ee/tenant",
+ "tags" : [ "/api/ee/tenant" ]
}
},
- "/api/ee/metabot-tools/get-transform-details" : {
- "post" : {
- "description" : "Get information about a transform.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-transform-details-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
+ "/api/ee/tenant/{id}" : {
+ "get" : {
+ "description" : "Get info about a tenant",
+ "operationId" : "get-api-ee-tenant-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "additionalProperties" : false,
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
+ "attributes" : {
"oneOf" : [ {
- "type" : "string"
+ "additionalProperties" : {
+ "type" : "string"
+ },
+ "type" : "object"
}, {
"type" : "null"
} ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "pattern" : "^[-_a-z0-9]{1,255}$",
+ "type" : "string"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
"type" : "object"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24417,37 +31964,52 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-transform-details",
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/get-transform-python-library-details" : {
- "post" : {
- "description" : "Get information about a Python library by path.",
- "parameters" : [ ],
+ "summary" : "GET /api/ee/tenant/{id}",
+ "tags" : [ "/api/ee/tenant" ]
+ },
+ "put" : {
+ "description" : "Update a tenant, can set name, attributes, or whether this tenant is active.",
+ "operationId" : "put-api-ee-tenant-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "additionalProperties" : false,
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.get-transform-python-library-details-arguments"
+ "attributes" : {
+ "oneOf" : [ {
+ "additionalProperties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "profile_id" : {
+ "name" : {
"oneOf" : [ {
+ "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -24458,27 +32020,51 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "additionalProperties" : false,
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
+ "attributes" : {
"oneOf" : [ {
- "type" : "string"
+ "additionalProperties" : {
+ "type" : "string"
+ },
+ "type" : "object"
}, {
"type" : "null"
} ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "type" : "boolean"
+ },
+ "member_count" : {
+ "description" : "value must be an integer.",
+ "type" : "integer"
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "slug" : {
+ "description" : "invalid slug",
+ "pattern" : "^[-_a-z0-9]{1,255}$",
+ "type" : "string"
+ },
+ "tenant_collection_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
"type" : "object"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24487,49 +32073,68 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-transform-python-library-details",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "PUT /api/ee/tenant/{id}",
+ "tags" : [ "/api/ee/tenant" ]
}
},
- "/api/ee/metabot-tools/get-transforms" : {
- "post" : {
- "description" : "Get a list of all known transforms.",
- "parameters" : [ ],
+ "/api/ee/transforms-python/library/{path}" : {
+ "get" : {
+ "description" : "Get the Python library for user modules.",
+ "operationId" : "get-api-ee-transforms-python-library-path",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "path",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/ee/transforms-python/library/{path}",
+ "tags" : [ "/api/ee/transforms-python" ]
+ },
+ "put" : {
+ "description" : "Update the Python library source code for user modules.",
+ "operationId" : "put-api-ee-transforms-python-library-path",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "path",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.deftool.tool-request"
+ "additionalProperties" : false,
+ "properties" : {
+ "source" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "source" ],
+ "type" : "object"
}
}
}
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
- },
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24538,37 +32143,54 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/get-transforms",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "PUT /api/ee/transforms-python/library/{path}",
+ "tags" : [ "/api/ee/transforms-python" ]
}
},
- "/api/ee/metabot-tools/query-datasource" : {
+ "/api/ee/transforms-python/test-run" : {
"post" : {
- "description" : "Construct a query from a model or table data source.",
+ "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.",
+ "operationId" : "post-api-ee-transforms-python-test-run",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.query-datasource-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "code" : {
"type" : "string"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
+ "output_row_limit" : {
+ "allOf" : [ {
+ "type" : "integer"
}, {
- "type" : "null"
+ "exclusiveMinimum" : 1,
+ "type" : "number"
+ }, {
+ "maximum" : 100,
+ "type" : "number"
+ } ]
+ },
+ "per_input_row_limit" : {
+ "allOf" : [ {
+ "type" : "integer"
+ }, {
+ "exclusiveMinimum" : 1,
+ "type" : "number"
+ }, {
+ "maximum" : 100,
+ "type" : "number"
} ]
+ },
+ "source_tables" : {
+ "additionalProperties" : {
+ "type" : "integer"
+ },
+ "minProperties" : 1,
+ "type" : "object"
}
},
- "required" : [ "arguments", "conversation_id" ],
+ "required" : [ "code", "source_tables" ],
"type" : "object"
}
}
@@ -24579,27 +32201,48 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "error" : {
+ "properties" : {
+ "message" : {
+ "anyOf" : [ { }, { } ]
+ }
+ },
+ "required" : [ "message" ],
+ "type" : "object"
+ },
+ "logs" : {
"type" : "string"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "output" : {
+ "properties" : {
+ "cols" : {
+ "items" : {
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "rows" : {
+ "items" : { },
+ "type" : "array"
+ }
+ },
+ "required" : [ "cols", "rows" ],
+ "type" : "object"
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "logs" ],
"type" : "object"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24608,68 +32251,130 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/query-datasource",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "POST /api/ee/transforms-python/test-run",
+ "tags" : [ "/api/ee/transforms-python" ]
}
},
- "/api/ee/metabot-tools/query-metric" : {
- "post" : {
- "description" : "Construct a query from a metric.",
+ "/api/ee/upload-management/tables" : {
+ "get" : {
+ "description" : "Get all `Tables` visible to the current user which were created by uploading a file.",
+ "operationId" : "get-api-ee-upload-management-tables",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.query-metric-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "arguments", "conversation_id" ],
- "type" : "object"
- }
- }
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/ee/upload-management/tables",
+ "tags" : [ "/api/ee/upload-management" ]
+ }
+ },
+ "/api/ee/upload-management/tables/{id}" : {
+ "delete" : {
+ "description" : "Delete the uploaded table from the database, optionally archiving cards for which it is the primary source.",
+ "operationId" : "delete-api-ee-upload-management-tables-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "archive-cards",
+ "required" : false,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "DELETE /api/ee/upload-management/tables/{id}",
+ "tags" : [ "/api/ee/upload-management" ]
+ }
+ },
+ "/api/ee/workspace" : {
+ "get" : {
+ "description" : "Get a list of all workspaces",
+ "operationId" : "get-api-ee-workspace",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
+ "additionalProperties" : false,
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
+ "items" : {
+ "items" : {
+ "additionalProperties" : false,
+ "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" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.status"
+ },
+ "updated_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "database_id", "name", "status", "updated_at" ],
+ "type" : "object"
+ },
+ "type" : "array"
},
- "profile_id" : {
+ "limit" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "offset" : {
+ "oneOf" : [ {
+ "type" : "integer"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "items", "limit", "offset" ],
"type" : "object"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24678,37 +32383,26 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/query-metric",
- "tags" : [ "/api/ee/metabot-tools" ]
- }
- },
- "/api/ee/metabot-tools/query-model" : {
+ "summary" : "GET /api/ee/workspace",
+ "tags" : [ "/api/ee/workspace" ]
+ },
"post" : {
- "description" : "Construct a query from a model.",
+ "description" : "Create a new workspace\n\n Potential payload:\n {:name \"a\" :database_id 2}}",
+ "operationId" : "post-api-ee-workspace",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.query-model-arguments"
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "name" : {
+ "minLength" : 1,
"type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
}
},
- "required" : [ "arguments", "conversation_id" ],
"type" : "object"
}
}
@@ -24719,27 +32413,40 @@
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "api_key" : {
"type" : "string"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "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" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.status"
+ },
+ "updated_at" : {
+ "format" : "date-time",
+ "type" : "string"
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ],
"type" : "object"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24748,68 +32455,108 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/query-model",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "POST /api/ee/workspace",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-tools/search" : {
- "post" : {
- "description" : "Enhanced search with term and semantic queries using Reciprocal Rank Fusion.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.search-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
- }
- }
+ "/api/ee/workspace/checkout" : {
+ "get" : {
+ "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-ee-workspace-checkout",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "transform-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "profile_id" : {
+ "checkout_disabled" : {
"oneOf" : [ {
+ "enum" : [ "mbql", "card-reference", "unknown-type" ],
"type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "transforms" : {
+ "items" : {
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "workspace" : {
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ],
+ "type" : "object"
+ }
+ },
+ "required" : [ "id", "name", "workspace" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "workspaces" : {
+ "items" : {
+ "properties" : {
+ "existing" : {
+ "oneOf" : [ {
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ },
+ "required" : [ "ref_id", "name" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.status"
+ }
+ },
+ "required" : [ "id", "name", "status", "existing" ],
+ "type" : "object"
+ },
+ "type" : "array"
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "checkout_disabled", "workspaces", "transforms" ],
"type" : "object"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24818,68 +32565,108 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/search",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "GET /api/ee/workspace/checkout",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-tools/search_v2" : {
- "post" : {
- "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.",
+ "/api/ee/workspace/database" : {
+ "get" : {
+ "description" : "Get a list supported databases, and whether they're enabled and have required permissions.",
+ "operationId" : "get-api-ee-workspace-database",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
- "properties" : {
- "arguments" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.tools.api.search-arguments"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "databases" : {
+ "items" : {
+ "properties" : {
+ "enabled" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "permissions_status" : {
+ "properties" : {
+ "checked_at" : {
+ "type" : "string"
+ },
+ "error" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "status", "checked_at" ],
+ "type" : "object"
+ }
+ },
+ "required" : [ "id", "name", "enabled" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "conversation_id" ],
- "type" : "object"
+ "required" : [ "databases" ],
+ "type" : "object"
+ }
}
- }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/ee/workspace/database",
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/enabled" : {
+ "get" : {
+ "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-ee-workspace-enabled",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "database-id",
+ "required" : false,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID.",
"properties" : {
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "reason" : {
"type" : "string"
},
- "profile_id" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "supported" : {
+ "type" : "boolean"
}
},
- "required" : [ "conversation_id" ],
+ "required" : [ "supported" ],
"type" : "object"
}
}
},
- "description" : "Base schema for all tool requests. Contains the conversation ID and optional profile ID."
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -24888,57 +32675,33 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-tools/search_v2",
- "tags" : [ "/api/ee/metabot-tools" ]
+ "summary" : "GET /api/ee/workspace/enabled",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-v3/agent-streaming" : {
+ "/api/ee/workspace/test-resources" : {
"post" : {
- "description" : "Send a chat message to the LLM via the AI Proxy.",
+ "description" : "Create test resources for workspace e2e tests. Only available in dev/test mode.\n\n Optionally accepts a database_id in the body; if not provided it will try to use the sample database.",
+ "operationId" : "post-api-ee-workspace-test-resources",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "context" : {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.context.context"
- },
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- },
- "history" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase-enterprise.metabot-v3.client.schema.messages"
- }, {
- "type" : "null"
- } ]
- },
- "message" : {
- "minLength" : 1,
- "type" : "string"
- },
- "metabot_id" : {
- "type" : "string"
- },
- "profile_id" : {
- "type" : "string"
- },
- "state" : {
- "properties" : { },
- "type" : "object"
- }
- },
- "required" : [ "message", "context", "conversation_id", "history", "state" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.test-resources-request"
}
}
}
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.test-resources-response"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -24948,30 +32711,141 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-v3/agent-streaming",
- "tags" : [ "/api/ee/metabot-v3" ]
+ "summary" : "POST /api/ee/workspace/test-resources",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-v3/document/generate-content" : {
- "post" : {
- "description" : "Create a new piece of content to insert into the document.",
- "parameters" : [ ],
+ "/api/ee/workspace/{ws-id}" : {
+ "delete" : {
+ "description" : "Delete a workspace and all its contents, including mirrored entities.",
+ "operationId" : "delete-api-ee-workspace-ws-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "ok" : {
+ "const" : true
+ }
+ },
+ "required" : [ "ok" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "DELETE /api/ee/workspace/{ws-id}",
+ "tags" : [ "/api/ee/workspace" ]
+ },
+ "get" : {
+ "description" : "Get a single workspace by ID",
+ "operationId" : "get-api-ee-workspace-ws-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "api_key" : {
+ "type" : "string"
+ },
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "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" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.status"
+ },
+ "updated_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ],
+ "type" : "object"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/ee/workspace/{ws-id}",
+ "tags" : [ "/api/ee/workspace" ]
+ },
+ "put" : {
+ "description" : "Update simple workspace properties.\n\n Can set database_id only on uninitialized workspaces.",
+ "operationId" : "put-api-ee-workspace-ws-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
+ "additionalProperties" : false,
"properties" : {
- "instructions" : {
+ "database_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
"minLength" : 1,
"type" : "string"
- },
- "references" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
}
},
- "required" : [ "instructions" ],
"type" : "object"
}
}
@@ -24979,6 +32853,42 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "api_key" : {
+ "type" : "string"
+ },
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "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" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.status"
+ },
+ "updated_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -24988,26 +32898,62 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-v3/document/generate-content",
- "tags" : [ "/api/ee/metabot-v3/document" ]
+ "summary" : "PUT /api/ee/workspace/{ws-id}",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-v3/feedback" : {
+ "/api/ee/workspace/{ws-id}/archive" : {
"post" : {
- "description" : "Proxy Metabot feedback to Harbormaster, adding the premium embedding token.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : { },
- "type" : "object"
- }
- }
+ "description" : "Archive a workspace. Deletes the isolated schema and tables, but preserves mirrored entities.",
+ "operationId" : "post-api-ee-workspace-ws-id-archive",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "api_key" : {
+ "type" : "string"
+ },
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "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" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.status"
+ },
+ "updated_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -25017,16 +32963,66 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-v3/feedback",
- "tags" : [ "/api/ee/metabot-v3" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/archive",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-v3/metabot/" : {
+ "/api/ee/workspace/{ws-id}/external/transform" : {
"get" : {
- "description" : "List configured metabot instances",
- "parameters" : [ ],
+ "description" : "Get transforms that are external to the workspace, i.e. no matching workspace_transform row exists.",
+ "operationId" : "get-api-ee-workspace-ws-id-external-transform",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "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"
+ }
+ } ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "transforms" : {
+ "items" : {
+ "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" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "transforms" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -25036,16 +33032,18 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/metabot-v3/metabot/",
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "summary" : "GET /api/ee/workspace/{ws-id}/external/transform",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-v3/metabot/{id}" : {
+ "/api/ee/workspace/{ws-id}/graph" : {
"get" : {
- "description" : "Retrieve one metabot instance",
+ "description" : "Display the dependency graph between the Changeset and the (potentially external) entities that they depend on.",
+ "operationId" : "get-api-ee-workspace-ws-id-graph",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -25054,6 +33052,28 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "edges" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.graph-edge"
+ },
+ "type" : "array"
+ },
+ "nodes" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.graph-node"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "nodes", "edges" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -25063,38 +33083,53 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/metabot-v3/metabot/{id}",
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
- },
- "put" : {
- "description" : "Update a metabot instance",
+ "summary" : "GET /api/ee/workspace/{ws-id}/graph",
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/input/grant" : {
+ "post" : {
+ "description" : "Grant read access to input tables by table coordinates. Superuser only.\n Idempotent - returns which tables were already granted vs newly granted.",
+ "operationId" : "post-api-ee-workspace-ws-id-input-grant",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "additionalProperties" : false,
"properties" : {
- "collection_id" : {
- "oneOf" : [ {
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "use_verified_content" : {
- "type" : "boolean"
+ "tables" : {
+ "items" : {
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "db_id", "schema", "table" ],
+ "type" : "object"
+ },
+ "type" : "array"
}
},
+ "required" : [ "tables" ],
"type" : "object"
}
}
@@ -25102,6 +33137,64 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "already_granted" : {
+ "items" : {
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "db_id", "schema", "table" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "newly_granted" : {
+ "items" : {
+ "properties" : {
+ "db_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "db_id", "schema", "table" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "already_granted", "newly_granted" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -25111,24 +33204,56 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/metabot-v3/metabot/{id}",
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/input/grant",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions" : {
- "delete" : {
- "description" : "Delete all prompt suggestions for the metabot instance with `id`.",
+ "/api/ee/workspace/{ws-id}/input/pending" : {
+ "get" : {
+ "description" : "List all input tables that haven't been granted access yet, excluding tables shadowed by workspace outputs.",
+ "operationId" : "get-api-ee-workspace-ws-id-input-pending",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "inputs" : {
+ "items" : {
+ "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" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "inputs" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -25138,45 +33263,89 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/metabot-v3/metabot/{id}/prompt-suggestions",
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
- },
+ "summary" : "GET /api/ee/workspace/{ws-id}/input/pending",
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/log" : {
"get" : {
- "description" : "Return the prompt suggestions for the metabot instance with `id`.",
+ "description" : "Get workspace creation status and recent log entries for polling during async setup",
+ "operationId" : "get-api-ee-workspace-ws-id-log",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "sample",
- "required" : false,
- "schema" : {
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "model",
- "required" : false,
- "schema" : {
- "enum" : [ "metric", "model" ],
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "model_id",
- "required" : false,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "last_completed_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "logs" : {
+ "items" : {
+ "properties" : {
+ "completed_at" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : { },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "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" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.status"
+ },
+ "updated_at" : { },
+ "workspace_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "workspace_id", "status", "updated_at", "last_completed_at", "logs" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -25186,24 +33355,117 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/metabot-v3/metabot/{id}/prompt-suggestions",
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "summary" : "GET /api/ee/workspace/{ws-id}/log",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/regenerate" : {
+ "/api/ee/workspace/{ws-id}/merge" : {
"post" : {
- "description" : "Remove any existing prompt suggestions for the Metabot instance with `id` and generate new ones.",
+ "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)",
+ "operationId" : "post-api-ee-workspace-ws-id-merge",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "commit-message" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "anyOf" : [ {
+ "properties" : {
+ "errors" : {
+ "items" : {
+ "properties" : {
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "op" : {
+ "enum" : [ "create", "delete", "update", "noop" ],
+ "type" : "string"
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ },
+ "required" : [ "op", "ref_id" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "merged" : {
+ "properties" : {
+ "transforms" : {
+ "items" : {
+ "properties" : {
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "op" : {
+ "enum" : [ "create", "delete", "update", "noop" ],
+ "type" : "string"
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ }
+ },
+ "required" : [ "op", "ref_id" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "transforms" ],
+ "type" : "object"
+ },
+ "workspace" : {
+ "properties" : {
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ],
+ "type" : "object"
+ }
+ },
+ "required" : [ "merged", "errors", "workspace" ],
+ "type" : "object"
+ }, {
+ "type" : "string"
+ } ]
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -25213,24 +33475,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/metabot-v3/metabot/{id}/prompt-suggestions/regenerate",
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/merge",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}" : {
- "delete" : {
- "description" : "Delete the prompt suggestion with ID `prompt-id` for the metabot instance with `id`.",
+ "/api/ee/workspace/{ws-id}/problem" : {
+ "get" : {
+ "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.",
+ "operationId" : "get-api-ee-workspace-ws-id-problem",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "path",
- "name" : "prompt-id",
+ "name" : "ws-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -25239,6 +33495,16 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.problem"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -25248,43 +33514,44 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/metabot-v3/metabot/{id}/prompt-suggestions/{prompt-id}",
- "tags" : [ "/api/ee/metabot-v3/metabot" ]
+ "summary" : "GET /api/ee/workspace/{ws-id}/problem",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/permission_debug/" : {
- "get" : {
- "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 ```",
+ "/api/ee/workspace/{ws-id}/query" : {
+ "post" : {
+ "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-ee-workspace-ws-id-query",
"parameters" : [ {
- "in" : "query",
- "name" : "user_id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "model_id",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "action_type",
+ "in" : "path",
+ "name" : "ws-id",
"required" : true,
"schema" : {
- "enum" : [ "card/read", "card/query", "card/download-data" ],
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "sql" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "sql" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.permission-debug.impl.perm-debug-info"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.query-result"
}
}
},
@@ -25297,28 +33564,62 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/permission_debug/",
- "tags" : [ "/api/ee/permission_debug" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/query",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/remote-sync/branches" : {
- "get" : {
- "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" : [ ],
+ "/api/ee/workspace/{ws-id}/run" : {
+ "post" : {
+ "description" : "Execute all transforms in the workspace in dependency order.\n Returns which transforms succeeded, failed, and were not run.",
+ "operationId" : "post-api-ee-workspace-ws-id-run",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "stale_only" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.flag"
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "items" : {
+ "failed" : {
"items" : {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "type" : "array"
+ },
+ "not_run" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "type" : "array"
+ },
+ "succeeded" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
},
"type" : "array"
}
},
- "required" : [ "items" ],
+ "required" : [ "succeeded", "failed", "not_run" ],
"type" : "object"
}
}
@@ -25332,44 +33633,45 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/remote-sync/branches",
- "tags" : [ "/api/ee/remote-sync" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/run",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/remote-sync/create-branch" : {
- "post" : {
- "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" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "name" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "name" ],
- "type" : "object"
- }
- }
+ "/api/ee/workspace/{ws-id}/table" : {
+ "get" : {
+ "description" : "Get workspace tables",
+ "operationId" : "get-api-ee-workspace-ws-id-table",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
+ "additionalProperties" : false,
"properties" : {
- "message" : {
- "type" : "string"
+ "inputs" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.input-table"
+ },
+ "type" : "array"
},
- "status" : {
- "type" : "string"
+ "outputs" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.output-table"
+ },
+ "type" : "array"
}
},
- "required" : [ "status", "message" ],
+ "required" : [ "inputs", "outputs" ],
"type" : "object"
}
}
@@ -25383,88 +33685,68 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/remote-sync/create-branch",
- "tags" : [ "/api/ee/remote-sync" ]
+ "summary" : "GET /api/ee/workspace/{ws-id}/table",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/remote-sync/current-task" : {
+ "/api/ee/workspace/{ws-id}/transform" : {
"get" : {
- "description" : "Get the current sync task",
- "parameters" : [ ],
+ "description" : "Get all transforms in a workspace.",
+ "operationId" : "get-api-ee-workspace-ws-id-transform",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ } ],
"responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "oneOf" : [ {
- "properties" : {
- "cancelled" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "ended_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "error_message" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "minimum" : 1,
- "type" : "integer"
- },
- "initiated_by" : {
- "oneOf" : [ {
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "last_progress_report_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "progress" : {
- "oneOf" : [ {
- "maximum" : 1.0,
- "minimum" : 0.0,
- "type" : "number"
- }, {
- "type" : "null"
- } ]
- },
- "started_at" : { },
- "status" : {
- "enum" : [ "running", "successful", "errored", "cancelled", "timed-out" ],
- "type" : "string"
- },
- "sync_task_type" : {
- "enum" : [ "import", "export" ],
- "type" : "string"
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "transforms" : {
+ "items" : {
+ "additionalProperties" : false,
+ "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" ],
+ "type" : "object"
},
- "version" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "sync_task_type", "progress", "started_at", "status" ],
- "type" : "object"
- }, {
- "type" : "null"
- } ]
+ "type" : "array"
+ }
+ },
+ "required" : [ "transforms" ],
+ "type" : "object"
}
}
},
@@ -25477,83 +33759,116 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/remote-sync/current-task",
- "tags" : [ "/api/ee/remote-sync" ]
- }
- },
- "/api/ee/remote-sync/current-task/cancel" : {
+ "summary" : "GET /api/ee/workspace/{ws-id}/transform",
+ "tags" : [ "/api/ee/workspace" ]
+ },
"post" : {
- "description" : "Cancels the current task if one is running",
- "parameters" : [ ],
+ "description" : "Add another transform to the Changeset. This could be a fork of an existing global transform, or something new.",
+ "operationId" : "post-api-ee-workspace-ws-id-transform",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "source" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.transform-source"
+ }
+ },
+ "required" : [ "name", "source" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "cancelled" : {
+ "archived_at" : { },
+ "created_at" : { },
+ "creator_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}, {
"type" : "null"
} ]
},
- "ended_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "error_message" : {
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "id" : {
- "minimum" : 1,
- "type" : "integer"
- },
- "initiated_by" : {
+ "global_id" : {
"oneOf" : [ {
- "minimum" : 1,
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}, {
"type" : "null"
} ]
},
- "last_progress_report_at" : {
- "oneOf" : [ { }, {
+ "last_run_at" : { },
+ "last_run_message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
"type" : "null"
} ]
},
- "progress" : {
+ "last_run_status" : {
"oneOf" : [ {
- "maximum" : 1.0,
- "minimum" : 0.0,
- "type" : "number"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "started_at" : { },
- "status" : {
- "enum" : [ "running", "successful", "errored", "cancelled", "timed-out" ],
+ "name" : {
"type" : "string"
},
- "sync_task_type" : {
- "enum" : [ "import", "export" ],
- "type" : "string"
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
},
- "version" : {
+ "source" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "target" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "target_stale" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
+ },
+ "updated_at" : { },
+ "workspace_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
},
- "required" : [ "id", "sync_task_type", "progress", "started_at", "status" ],
+ "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" ],
"type" : "object"
}
}
@@ -25567,105 +33882,84 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/remote-sync/current-task/cancel",
- "tags" : [ "/api/ee/remote-sync" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/remote-sync/dirty" : {
- "get" : {
- "description" : "Return all models with changes that have not been pushed to the remote sync source in any\n remote-synced collection.",
- "parameters" : [ ],
+ "/api/ee/workspace/{ws-id}/transform/validate/target" : {
+ "post" : {
+ "description" : "Validate the target table for a workspace transform",
+ "operationId" : "post-api-ee-workspace-ws-id-transform-validate-target",
+ "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"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "db_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "target" : {
+ "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" ],
+ "type" : "object"
+ }
+ },
+ "required" : [ "target" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "dirty" : {
- "items" : {
- "properties" : {
- "authority_level" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "created_at" : { },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "minimum" : 1,
- "type" : "integer"
- },
- "model" : {
- "type" : "string"
- },
- "name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "query_type" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "sync_status" : {
- "type" : "string"
- },
- "table_id" : {
- "oneOf" : [ {
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "table_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "updated_at" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "id", "name", "model", "sync_status" ],
- "type" : "object"
- },
- "type" : "array"
+ "body" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ },
+ "status" : {
+ "type" : "integer"
}
},
- "required" : [ "dirty" ],
+ "required" : [ "status", "body" ],
"type" : "object"
}
}
@@ -25679,30 +33973,35 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/remote-sync/dirty",
- "tags" : [ "/api/ee/remote-sync" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/validate/target",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/remote-sync/export" : {
- "post" : {
- "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/workspace/{ws-id}/transform/{tx-id}" : {
+ "delete" : {
+ "description" : "Discard a transform from the changeset.\n Equivalent to resetting a checked-out transform to its global definition, or deleting a provisional transform.",
+ "operationId" : "delete-api-ee-workspace-ws-id-transform-tx-id",
+ "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" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "message" : {
- "type" : "string"
- },
- "task_id" : {
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "message", "task_id" ],
- "type" : "object"
+ "type" : "null"
}
}
},
@@ -25715,19 +34014,25 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/remote-sync/export",
- "tags" : [ "/api/ee/remote-sync" ]
- }
- },
- "/api/ee/remote-sync/has-remote-changes" : {
+ "summary" : "DELETE /api/ee/workspace/{ws-id}/transform/{tx-id}",
+ "tags" : [ "/api/ee/workspace" ]
+ },
"get" : {
- "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",
+ "description" : "Get a specific transform in a workspace.",
+ "operationId" : "get-api-ee-workspace-ws-id-transform-tx-id",
"parameters" : [ {
- "in" : "query",
- "name" : "force-refresh",
- "required" : false,
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
"schema" : {
- "type" : "boolean"
+ "$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" : {
@@ -25736,28 +34041,71 @@
"application/json" : {
"schema" : {
"properties" : {
- "cached" : {
- "type" : "boolean"
+ "archived_at" : { },
+ "created_at" : { },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
},
- "has_changes" : {
- "type" : "boolean"
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "local_version" : {
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_run_at" : { },
+ "last_run_message" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "remote_version" : {
+ "last_run_status" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "source" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "target" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "target_stale" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : { },
+ "workspace_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
},
- "required" : [ "has_changes", "remote_version", "local_version", "cached" ],
+ "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" ],
"type" : "object"
}
}
@@ -25771,25 +34119,47 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/remote-sync/has-remote-changes",
- "tags" : [ "/api/ee/remote-sync" ]
- }
- },
- "/api/ee/remote-sync/import" : {
- "post" : {
- "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" : [ ],
+ "summary" : "GET /api/ee/workspace/{ws-id}/transform/{tx-id}",
+ "tags" : [ "/api/ee/workspace" ]
+ },
+ "put" : {
+ "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.",
+ "operationId" : "put-api-ee-workspace-ws-id-transform-tx-id",
+ "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"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "branch" : {
- "minLength" : 1,
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
"type" : "string"
},
- "force" : {
- "type" : "boolean"
+ "source" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.transform-source"
+ },
+ "target" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.transform-target"
}
},
"type" : "object"
@@ -25803,26 +34173,71 @@
"application/json" : {
"schema" : {
"properties" : {
- "message" : {
+ "archived_at" : { },
+ "created_at" : { },
+ "creator_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "status" : {
- "const" : "success"
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
},
- "task_id" : {
+ "last_run_at" : { },
+ "last_run_message" : {
"oneOf" : [ {
- "minimum" : 1,
- "type" : "integer"
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_run_status" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
+ },
+ "source" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "target" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "target_stale" : {
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
"type" : "null"
} ]
+ },
+ "updated_at" : { },
+ "workspace_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
}
},
- "required" : [ "status", "task_id" ],
+ "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" ],
"type" : "object"
}
}
@@ -25836,89 +34251,77 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/remote-sync/import",
- "tags" : [ "/api/ee/remote-sync" ]
+ "summary" : "PUT /api/ee/workspace/{ws-id}/transform/{tx-id}",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/remote-sync/is-dirty" : {
- "get" : {
- "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" : [ ],
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/archive" : {
+ "post" : {
+ "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.",
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-archive",
+ "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" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "is_dirty" : {
- "type" : "boolean"
- }
- },
- "required" : [ "is_dirty" ],
- "type" : "object"
+ "type" : "null"
}
}
},
"description" : "Successful response"
},
"4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/ee/remote-sync/is-dirty",
- "tags" : [ "/api/ee/remote-sync" ]
- }
- },
- "/api/ee/remote-sync/settings" : {
- "put" : {
- "description" : "Update Remote Sync related settings. You must be a superuser to do this.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "collections" : {
- "oneOf" : [ {
- "additionalProperties" : {
- "type" : "boolean"
- },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-branch" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-token" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-type" : {
- "oneOf" : [ {
- "enum" : [ "read-only", "read-write" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "remote-sync-url" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/archive",
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/dry-run" : {
+ "post" : {
+ "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.",
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-dry-run",
+ "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"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "run_stale_ancestors" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.flag"
}
},
"type" : "object"
@@ -25931,17 +34334,7 @@
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "success" : {
- "type" : "boolean"
- },
- "task_id" : {
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "success" ],
- "type" : "object"
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.query-result"
}
}
},
@@ -25954,29 +34347,39 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/remote-sync/settings",
- "tags" : [ "/api/ee/remote-sync" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/dry-run",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/remote-sync/stash" : {
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/merge" : {
"post" : {
- "description" : "Stashes changes to a new branch, and changes the current branch to it.\n Requires superuser permissions.",
- "parameters" : [ ],
+ "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)",
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-merge",
+ "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"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "message" : {
- "minLength" : 1,
- "type" : "string"
- },
- "new_branch" : {
+ "commit-message" : {
"minLength" : 1,
"type" : "string"
}
},
- "required" : [ "new_branch", "message" ],
"type" : "object"
}
}
@@ -25988,18 +34391,25 @@
"application/json" : {
"schema" : {
"properties" : {
+ "global_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ }, {
+ "type" : "null"
+ } ]
+ },
"message" : {
"type" : "string"
},
- "status" : {
+ "op" : {
+ "enum" : [ "create", "delete", "update", "noop" ],
"type" : "string"
},
- "task_id" : {
- "minimum" : 1,
- "type" : "integer"
+ "ref_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.ref-id"
}
},
- "required" : [ "status", "message", "task_id" ],
+ "required" : [ "op", "global_id", "ref_id" ],
"type" : "object"
}
}
@@ -26013,16 +34423,52 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/remote-sync/stash",
- "tags" : [ "/api/ee/remote-sync" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/merge",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/scim/api_key" : {
- "get" : {
- "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" : [ ],
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/run" : {
+ "post" : {
+ "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.",
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-run",
+ "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"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "run_stale_ancestors" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.flag"
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.execution-result"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -26032,14 +34478,38 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/scim/api_key",
- "tags" : [ "/api/ee/scim" ]
- },
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/run",
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/ee/workspace/{ws-id}/transform/{tx-id}/unarchive" : {
"post" : {
- "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" : [ ],
+ "description" : "Unmark the given transform for archival. This will recall the last definition it had within the workspace.",
+ "operationId" : "post-api-ee-workspace-ws-id-transform-tx-id-unarchive",
+ "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" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -26049,54 +34519,62 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/scim/api_key",
- "tags" : [ "/api/ee/scim" ]
+ "summary" : "POST /api/ee/workspace/{ws-id}/transform/{tx-id}/unarchive",
+ "tags" : [ "/api/ee/workspace" ]
}
},
- "/api/ee/scim/v2/Groups" : {
- "get" : {
- "description" : "Fetch a list of groups.",
+ "/api/ee/workspace/{ws-id}/unarchive" : {
+ "post" : {
+ "description" : "Restore an archived workspace. Recreates the isolated schema and tables.",
+ "operationId" : "post-api-ee-workspace-ws-id-unarchive",
"parameters" : [ {
- "in" : "query",
- "name" : "startIndex",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "count",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "filter",
- "required" : false,
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "ws-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "api_key" : {
+ "type" : "string"
+ },
+ "collection_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.types.appdb-id"
+ },
+ "created_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ },
+ "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" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.workspaces.api.status"
+ },
+ "updated_at" : {
+ "format" : "date-time",
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "collection_id", "database_id", "status", "created_at", "updated_at" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -26106,51 +34584,26 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/scim/v2/Groups",
- "tags" : [ "/api/ee/scim/v2" ]
- },
+ "summary" : "POST /api/ee/workspace/{ws-id}/unarchive",
+ "tags" : [ "/api/ee/workspace" ]
+ }
+ },
+ "/api/eid-translation/translate" : {
"post" : {
- "description" : "Create a single group, and populates it if necessary.",
+ "description" : "Translate entity IDs to model IDs.",
+ "operationId" : "post-api-eid-translation-translate",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "displayName" : {
- "minLength" : 1,
- "type" : "string"
- },
- "id" : {
- "minLength" : 1,
- "type" : "string"
- },
- "members" : {
- "items" : {
- "properties" : {
- "$ref" : {
- "minLength" : 1,
- "type" : "string"
- },
- "value" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "value" ],
- "type" : "object"
- },
- "type" : "array"
- },
- "schemas" : {
- "items" : {
- "minLength" : 1,
- "type" : "string"
- },
- "type" : "array"
+ "entity_ids" : {
+ "properties" : { },
+ "type" : "object"
}
},
- "required" : [ "schemas", "displayName" ],
+ "required" : [ "entity_ids" ],
"type" : "object"
}
}
@@ -26167,47 +34620,15 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/scim/v2/Groups",
- "tags" : [ "/api/ee/scim/v2" ]
+ "summary" : "POST /api/eid-translation/translate",
+ "tags" : [ "/api/eid-translation" ]
}
},
- "/api/ee/scim/v2/Groups/{id}" : {
+ "/api/email" : {
"delete" : {
- "description" : "Delete a group.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "DELETE /api/ee/scim/v2/Groups/{id}",
- "tags" : [ "/api/ee/scim/v2" ]
- },
- "get" : {
- "description" : "Fetch a single group.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- } ],
+ "description" : "Clear all email related settings. You must be a superuser or have `setting` permission to do this.",
+ "operationId" : "delete-api-email",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -26219,51 +34640,54 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/scim/v2/Groups/{id}",
- "tags" : [ "/api/ee/scim/v2" ]
+ "summary" : "DELETE /api/email",
+ "tags" : [ "/api/email" ]
},
"put" : {
- "description" : "Update a group.",
+ "description" : "Update multiple email Settings. You must be a superuser or have `setting` permission to do this.",
+ "operationId" : "put-api-email",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "displayName" : {
- "minLength" : 1,
- "type" : "string"
+ "email-smtp-host" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "id" : {
- "minLength" : 1,
- "type" : "string"
+ "email-smtp-password" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "members" : {
- "items" : {
- "properties" : {
- "$ref" : {
- "minLength" : 1,
- "type" : "string"
- },
- "value" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "value" ],
- "type" : "object"
- },
- "type" : "array"
+ "email-smtp-port" : {
+ "anyOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
},
- "schemas" : {
- "items" : {
- "minLength" : 1,
+ "email-smtp-security" : {
+ "anyOf" : [ {
"type" : "string"
- },
- "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email-smtp-username" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "schemas", "displayName" ],
"type" : "object"
}
}
@@ -26280,50 +34704,40 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/scim/v2/Groups/{id}",
- "tags" : [ "/api/ee/scim/v2" ]
+ "summary" : "PUT /api/email",
+ "tags" : [ "/api/email" ]
}
},
- "/api/ee/scim/v2/Users" : {
+ "/api/email/test" : {
+ "post" : {
+ "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-email-test",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/email/test",
+ "tags" : [ "/api/email" ]
+ }
+ },
+ "/api/embed/card/{token}" : {
"get" : {
- "description" : "Fetch a list of users.",
+ "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>}}",
+ "operationId" : "get-api-embed-card-token",
"parameters" : [ {
- "in" : "query",
- "name" : "startIndex",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "count",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "filter",
- "required" : false,
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
} ],
"responses" : {
@@ -26337,103 +34751,37 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/scim/v2/Users",
- "tags" : [ "/api/ee/scim/v2" ]
- },
- "post" : {
- "description" : "Create a single user.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "active" : {
- "type" : "boolean"
- },
- "emails" : {
- "items" : {
- "properties" : {
- "primary" : {
- "type" : "boolean"
- },
- "type" : {
- "minLength" : 1,
- "type" : "string"
- },
- "value" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "value" ],
- "type" : "object"
- },
- "type" : "array"
- },
- "groups" : {
- "items" : {
- "properties" : {
- "$ref" : {
- "minLength" : 1,
- "type" : "string"
- },
- "display" : {
- "minLength" : 1,
- "type" : "string"
- },
- "value" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "value", "display" ],
- "type" : "object"
- },
- "type" : "array"
- },
- "id" : {
- "minLength" : 1,
- "type" : "string"
- },
- "locale" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "properties" : {
- "familyName" : {
- "type" : "string"
- },
- "givenName" : {
- "type" : "string"
- }
- },
- "required" : [ "givenName", "familyName" ],
- "type" : "object"
- },
- "schemas" : {
- "items" : {
- "minLength" : 1,
- "type" : "string"
- },
- "type" : "array"
- },
- "userName" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "schemas", "userName", "name", "emails" ],
- "type" : "object"
- }
- }
+ "summary" : "GET /api/embed/card/{token}",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/params/{param-key}/remapping" : {
+ "get" : {
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "operationId" : "get-api-embed-card-token-params-param-key-remapping",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
- },
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -26445,16 +34793,32 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/scim/v2/Users",
- "tags" : [ "/api/ee/scim/v2" ]
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/remapping",
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/scim/v2/Users/{id}" : {
+ "/api/embed/card/{token}/params/{param-key}/search/{prefix}" : {
"get" : {
- "description" : "Fetch a single user.",
+ "description" : "Embedded version of chain filter search endpoint.",
+ "operationId" : "get-api-embed-card-token-params-param-key-search-prefix",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
"required" : true,
"schema" : {
"minLength" : 1,
@@ -26472,70 +34836,57 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/scim/v2/Users/{id}",
- "tags" : [ "/api/ee/scim/v2" ]
- },
- "patch" : {
- "description" : "Activate or deactivate a user. Supports specific replace operations, but not arbitrary patches.",
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/search/{prefix}",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/params/{param-key}/values" : {
+ "get" : {
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "operationId" : "get-api-embed-card-token-params-param-key-values",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
"required" : true,
"schema" : {
"minLength" : 1,
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "Operations" : {
- "items" : {
- "properties" : {
- "op" : {
- "minLength" : 1,
- "type" : "string"
- },
- "value" : {
- "anyOf" : [ {
- "additionalProperties" : {
- "anyOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "boolean"
- } ]
- },
- "type" : "object"
- }, {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "boolean"
- } ]
- }
- },
- "required" : [ "op", "value" ],
- "type" : "object"
- },
- "type" : "array"
- },
- "schemas" : {
- "items" : {
- "minLength" : 1,
- "type" : "string"
- },
- "type" : "array"
- }
- },
- "required" : [ "schemas", "Operations" ],
- "type" : "object"
- }
- }
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/embed/card/{token}/params/{param-key}/values",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/query" : {
+ "get" : {
+ "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>}",
+ "operationId" : "get-api-embed-card-token-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -26547,103 +34898,45 @@
"description" : "Server error response"
}
},
- "summary" : "PATCH /api/ee/scim/v2/Users/{id}",
- "tags" : [ "/api/ee/scim/v2" ]
- },
- "put" : {
- "description" : "Update a user.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "active" : {
- "type" : "boolean"
- },
- "emails" : {
- "items" : {
- "properties" : {
- "primary" : {
- "type" : "boolean"
- },
- "type" : {
- "minLength" : 1,
- "type" : "string"
- },
- "value" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "value" ],
- "type" : "object"
- },
- "type" : "array"
- },
- "groups" : {
- "items" : {
- "properties" : {
- "$ref" : {
- "minLength" : 1,
- "type" : "string"
- },
- "display" : {
- "minLength" : 1,
- "type" : "string"
- },
- "value" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "value", "display" ],
- "type" : "object"
- },
- "type" : "array"
- },
- "id" : {
- "minLength" : 1,
- "type" : "string"
- },
- "locale" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "properties" : {
- "familyName" : {
- "type" : "string"
- },
- "givenName" : {
- "type" : "string"
- }
- },
- "required" : [ "givenName", "familyName" ],
- "type" : "object"
- },
- "schemas" : {
- "items" : {
- "minLength" : 1,
- "type" : "string"
- },
- "type" : "array"
- },
- "userName" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "schemas", "userName", "name", "emails" ],
- "type" : "object"
- }
- }
+ "summary" : "GET /api/embed/card/{token}/query",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/card/{token}/query/{export-format}" : {
+ "get" : {
+ "description" : "Like `GET /api/embed/card/query`, but returns the results as a file in the specified format.",
+ "operationId" : "get-api-embed-card-token-query-export-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"
@@ -26655,14 +34948,22 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/scim/v2/Users/{id}",
- "tags" : [ "/api/ee/scim/v2" ]
+ "summary" : "GET /api/embed/card/{token}/query/{export-format}",
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/semantic-search/status" : {
+ "/api/embed/dashboard/{token}" : {
"get" : {
- "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" : [ ],
+ "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>}}",
+ "operationId" : "get-api-embed-dashboard-token",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -26674,77 +34975,94 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/semantic-search/status",
- "tags" : [ "/api/ee/semantic-search" ]
+ "summary" : "GET /api/embed/dashboard/{token}",
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/serialization/export" : {
- "post" : {
- "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/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "get" : {
+ "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-embed-dashboard-token-dashcard-dashcard-id-card-card-id",
"parameters" : [ {
- "description" : "name of directory and archive file (default: `<instance-name>-<YYYY-MM-dd_HH-mm>`)",
- "in" : "query",
- "name" : "dirname",
- "required" : false,
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
}, {
- "description" : "collections' db ids/entity-ids to serialize",
- "in" : "query",
- "name" : "collection",
- "required" : false,
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "items" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "pattern" : "^.{21}$",
- "type" : "string"
- }, {
- "pattern" : "^eid:.{21}$",
- "type" : "string"
- } ]
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
- "in" : "query",
- "name" : "all_collections",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
"required" : true,
"schema" : {
- "default" : true,
- "type" : "boolean"
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
+ "get" : {
+ "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",
+ "operationId" : "get-api-embed-dashboard-token-dashcard-dashcard-id-card-card-id-export-format",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
}, {
- "in" : "query",
- "name" : "settings",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
- "default" : true,
- "type" : "boolean"
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
- "in" : "query",
- "name" : "data_model",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
"required" : true,
"schema" : {
- "default" : true,
- "type" : "boolean"
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
}
}, {
"in" : "query",
- "name" : "field_values",
+ "name" : "format_rows",
"required" : true,
"schema" : {
"default" : false,
@@ -26752,27 +35070,151 @@
}
}, {
"in" : "query",
- "name" : "database_secrets",
+ "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"
+ }
+ },
+ "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/dashboard/{token}/params/{param-key}/remapping" : {
+ "get" : {
+ "description" : "Embedded version of the remapped dashboard param value endpoint.",
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-remapping",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
}, {
- "in" : "query",
- "name" : "continue_on_error",
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/remapping",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
+ "get" : {
+ "description" : "Embedded version of chain filter search endpoint.",
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-search-prefix",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/search/{prefix}",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/dashboard/{token}/params/{param-key}/values" : {
+ "get" : {
+ "description" : "Embedded version of chain filter values endpoint.",
+ "operationId" : "get-api-embed-dashboard-token-params-param-key-values",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
"required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
+ "minLength" : 1,
+ "type" : "string"
}
- }, {
- "in" : "query",
- "name" : "full_stacktrace",
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/values",
+ "tags" : [ "/api/embed" ]
+ }
+ },
+ "/api/embed/pivot/card/{token}/query" : {
+ "get" : {
+ "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>}",
+ "operationId" : "get-api-embed-pivot-card-token-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
"required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
+ "type" : "string"
}
} ],
"responses" : {
@@ -26786,68 +35228,40 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/serialization/export",
- "tags" : [ "/api/ee/serialization" ]
+ "summary" : "GET /api/embed/pivot/card/{token}/query",
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/serialization/import" : {
- "post" : {
- "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.",
+ "/api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "get" : {
+ "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-embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
"parameters" : [ {
- "in" : "query",
- "name" : "continue_on_error",
+ "in" : "path",
+ "name" : "token",
"required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
+ "type" : "string"
}
}, {
- "in" : "query",
- "name" : "full_stacktrace",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
- "in" : "query",
- "name" : "reindex",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
"required" : true,
"schema" : {
- "default" : true,
- "type" : "boolean"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
- "requestBody" : {
- "content" : {
- "multipart/form-data" : {
- "schema" : {
- "properties" : {
- "file" : {
- "additionalProperties" : false,
- "description" : ".tgz with serialization data",
- "properties" : {
- "content-type" : {
- "type" : "string"
- },
- "filename" : {
- "type" : "string"
- },
- "size" : {
- "type" : "integer"
- },
- "tempfile" : { }
- },
- "required" : [ "content-type", "filename", "size", "tempfile" ],
- "type" : "object"
- }
- },
- "required" : [ "file" ],
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -26859,61 +35273,65 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/serialization/import",
- "tags" : [ "/api/ee/serialization" ]
+ "summary" : "GET /api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/stale/{id}" : {
+ "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
"get" : {
- "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)",
+ "description" : "Generates a single tile image for an embedded Card using the map visualization.",
+ "operationId" : "get-api-embed-tiles-card-token-zoom-x-y",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "token",
"required" : true,
"schema" : {
- "anyOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "const" : "root"
- } ]
+ "type" : "string"
}
}, {
- "in" : "query",
- "name" : "before_date",
- "required" : false,
+ "description" : "value must be an integer.",
+ "in" : "path",
+ "name" : "zoom",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "type" : "integer"
}
}, {
- "in" : "query",
- "name" : "is_recursive",
+ "description" : "value must be an integer.",
+ "in" : "path",
+ "name" : "x",
"required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer.",
+ "in" : "path",
+ "name" : "y",
+ "required" : true,
+ "schema" : {
+ "type" : "integer"
}
}, {
+ "description" : "value must be a valid JSON string.",
"in" : "query",
- "name" : "sort_column",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "latField",
"required" : true,
"schema" : {
- "default" : "name",
- "enum" : [ "name", "last_used_at" ],
"type" : "string"
}
}, {
"in" : "query",
- "name" : "sort_direction",
+ "name" : "lonField",
"required" : true,
"schema" : {
- "default" : "asc",
- "enum" : [ "asc", "desc" ],
"type" : "string"
}
} ],
@@ -26928,91 +35346,88 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/stale/{id}",
- "tags" : [ "/api/ee/stale" ]
+ "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/support-access-grant/" : {
+ "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "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)",
+ "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
+ "operationId" : "get-api-embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
"parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer.",
+ "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 a valid JSON string.",
"in" : "query",
- "name" : "ticket-number",
+ "name" : "parameters",
"required" : false,
"schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
}, {
"in" : "query",
- "name" : "user-id",
- "required" : false,
+ "name" : "latField",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
}, {
"in" : "query",
- "name" : "include-revoked",
- "required" : false,
+ "name" : "lonField",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
} ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.list-grants-response"
- }
- }
- },
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/ee/support-access-grant/",
- "tags" : [ "/api/ee/support-access-grant" ]
- },
- "post" : {
- "description" : "Create a new support access grant.\n\n Requires superuser permissions. Only one active grant can exist at a time.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.create-grant-request"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -27022,39 +35437,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/support-access-grant/",
- "tags" : [ "/api/ee/support-access-grant" ]
+ "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
+ "tags" : [ "/api/embed" ]
}
},
- "/api/ee/support-access-grant/current" : {
+ "/api/field/{id}" : {
"get" : {
- "description" : "Get the currently active support access grant, if one exists.\n\n Requires superuser permissions.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.current-grant-response"
- }
- }
- },
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/ee/support-access-grant/current",
- "tags" : [ "/api/ee/support-access-grant" ]
- }
- },
- "/api/ee/support-access-grant/{id}/revoke" : {
- "put" : {
- "description" : "Revoke an existing support access grant.\n\n Requires superuser permissions. Any admin can revoke any grant.",
+ "description" : "Get `Field` with ID.",
+ "operationId" : "get-api-field-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -27064,101 +35454,17 @@
"minimum" : 1,
"type" : "integer"
}
- } ],
- "responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
- }
- }
- },
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "PUT /api/ee/support-access-grant/{id}/revoke",
- "tags" : [ "/api/ee/support-access-grant" ]
- }
- },
- "/api/ee/tenant/" : {
- "get" : {
- "description" : "Get all tenants",
- "parameters" : [ {
+ }, {
"in" : "query",
- "name" : "status",
+ "name" : "include_editable_data_model",
"required" : true,
"schema" : {
- "default" : "all",
- "enum" : [ "all", "deactivated", "active" ],
- "type" : "string"
+ "default" : false,
+ "type" : "boolean"
}
} ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "additionalProperties" : false,
- "properties" : {
- "data" : {
- "items" : {
- "additionalProperties" : false,
- "properties" : {
- "attributes" : {
- "oneOf" : [ {
- "additionalProperties" : {
- "type" : "string"
- },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "is_active" : {
- "type" : "boolean"
- },
- "member_count" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "slug" : {
- "description" : "invalid slug",
- "pattern" : "^[-_a-z0-9]{1,255}$",
- "type" : "string"
- },
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "type" : "object"
- },
- "type" : "array"
- }
- },
- "required" : [ "data" ],
- "type" : "object"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -27168,37 +35474,125 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/tenant/",
- "tags" : [ "/api/ee/tenant" ]
+ "summary" : "GET /api/field/{id}",
+ "tags" : [ "/api/field" ]
},
- "post" : {
- "description" : "Create a new Tenant",
- "parameters" : [ ],
+ "put" : {
+ "description" : "Update `Field` with ID.",
+ "operationId" : "put-api-field-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "additionalProperties" : false,
"properties" : {
- "attributes" : {
+ "caveats" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "coercion_strategy" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid coercion strategy (keyword or string)."
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target_field_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "has_field_values" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "json_unfolding" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "nfc_path" : {
+ "oneOf" : [ {
+ "items" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "points_of_interest" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid field semantic or relation type (keyword or string)."
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "settings" : {
"oneOf" : [ {
- "additionalProperties" : { },
+ "description" : "Value must be a map.",
+ "properties" : { },
"type" : "object"
}, {
"type" : "null"
} ]
},
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "slug" : {
- "description" : "invalid slug",
- "pattern" : "^[-_a-z0-9]{1,255}$",
- "type" : "string"
+ "visibility_type" : {
+ "oneOf" : [ {
+ "enum" : [ "retired", "sensitive", "normal", "hidden", "details-only" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "name", "slug" ],
"type" : "object"
}
}
@@ -27206,53 +35600,6 @@
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "additionalProperties" : false,
- "properties" : {
- "attributes" : {
- "oneOf" : [ {
- "additionalProperties" : {
- "type" : "string"
- },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "is_active" : {
- "type" : "boolean"
- },
- "member_count" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "slug" : {
- "description" : "invalid slug",
- "pattern" : "^[-_a-z0-9]{1,255}$",
- "type" : "string"
- },
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "type" : "object"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -27262,13 +35609,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/tenant/",
- "tags" : [ "/api/ee/tenant" ]
+ "summary" : "PUT /api/field/{id}",
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/tenant/{id}" : {
- "get" : {
- "description" : "Get info about a tenant",
+ "/api/field/{id}/dimension" : {
+ "delete" : {
+ "description" : "Remove the dimension associated to field at ID",
+ "operationId" : "delete-api-field-id-dimension",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -27281,53 +35629,6 @@
} ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "additionalProperties" : false,
- "properties" : {
- "attributes" : {
- "oneOf" : [ {
- "additionalProperties" : {
- "type" : "string"
- },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "is_active" : {
- "type" : "boolean"
- },
- "member_count" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "slug" : {
- "description" : "invalid slug",
- "pattern" : "^[-_a-z0-9]{1,255}$",
- "type" : "string"
- },
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "type" : "object"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -27337,11 +35638,12 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/tenant/{id}",
- "tags" : [ "/api/ee/tenant" ]
+ "summary" : "DELETE /api/field/{id}/dimension",
+ "tags" : [ "/api/field" ]
},
- "put" : {
- "description" : "Update a tenant, can set name, attributes, or whether this tenant is active.",
+ "post" : {
+ "description" : "Sets the dimension for the given field at ID",
+ "operationId" : "post-api-field-id-dimension",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -27356,32 +35658,26 @@
"content" : {
"application/json" : {
"schema" : {
- "additionalProperties" : false,
"properties" : {
- "attributes" : {
- "oneOf" : [ {
- "additionalProperties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "is_active" : {
+ "human_readable_field_id" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
"name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : {
+ "enum" : [ "internal", "external" ],
+ "type" : "string"
}
},
+ "required" : [ "type", "name" ],
"type" : "object"
}
}
@@ -27389,53 +35685,6 @@
},
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "additionalProperties" : false,
- "properties" : {
- "attributes" : {
- "oneOf" : [ {
- "additionalProperties" : {
- "type" : "string"
- },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "is_active" : {
- "type" : "boolean"
- },
- "member_count" : {
- "description" : "value must be an integer.",
- "type" : "integer"
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "slug" : {
- "description" : "invalid slug",
- "pattern" : "^[-_a-z0-9]{1,255}$",
- "type" : "string"
- },
- "tenant_collection_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "id", "name", "slug", "is_active", "member_count", "attributes", "tenant_collection_id" ],
- "type" : "object"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -27445,67 +35694,97 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/tenant/{id}",
- "tags" : [ "/api/ee/tenant" ]
+ "summary" : "POST /api/field/{id}/dimension",
+ "tags" : [ "/api/field" ]
+ }
+ },
+ "/api/field/{id}/discard_values" : {
+ "post" : {
+ "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.",
+ "operationId" : "post-api-field-id-discard_values",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/field/{id}/discard_values",
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/transform-job/" : {
+ "/api/field/{id}/related" : {
"get" : {
- "description" : "Get all transform jobs.",
+ "description" : "Return related entities.",
+ "operationId" : "get-api-field-id-related",
"parameters" : [ {
- "in" : "query",
- "name" : "last_run_start_time",
- "required" : false,
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "next_run_start_time",
- "required" : false,
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/field/{id}/related",
+ "tags" : [ "/api/field" ]
+ }
+ },
+ "/api/field/{id}/remapping/{remapped-id}" : {
+ "get" : {
+ "description" : "Fetch remapped Field values.",
+ "operationId" : "get-api-field-id-remapping-remapped-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
- "in" : "query",
- "name" : "last_run_statuses",
- "required" : false,
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "remapped-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "items" : {
- "enum" : [ "started", "succeeded", "failed", "timeout" ],
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
"in" : "query",
- "name" : "tag_ids",
- "required" : false,
+ "name" : "value",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
+ "minLength" : 1,
+ "type" : "string"
}
} ],
"responses" : {
@@ -27519,53 +35798,70 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/transform-job/",
- "tags" : [ "/api/ee/transform-job" ]
- },
+ "summary" : "GET /api/field/{id}/remapping/{remapped-id}",
+ "tags" : [ "/api/field" ]
+ }
+ },
+ "/api/field/{id}/rescan_values" : {
"post" : {
- "description" : "Create a new transform job.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "description" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "schedule" : {
- "minLength" : 1,
- "type" : "string"
- },
- "tag_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
- },
- "ui_display_type" : {
- "default" : "cron/raw",
- "enum" : [ "cron/raw", "cron/builder" ],
- "type" : "string"
- }
- },
- "required" : [ "name", "schedule", "ui_display_type" ],
- "type" : "object"
- }
- }
+ "description" : "Manually trigger an update for the FieldValues for this Field. Only applies to Fields that are eligible for\n FieldValues.",
+ "operationId" : "post-api-field-id-rescan_values",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "POST /api/field/{id}/rescan_values",
+ "tags" : [ "/api/field" ]
+ }
+ },
+ "/api/field/{id}/search/{search-id}" : {
+ "get" : {
+ "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.",
+ "operationId" : "get-api-field-id-search-search-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "search-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : false,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -27577,17 +35873,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/transform-job/",
- "tags" : [ "/api/ee/transform-job" ]
+ "summary" : "GET /api/field/{id}/search/{search-id}",
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/transform-job/{job-id}" : {
- "delete" : {
- "description" : "Delete a transform job.",
+ "/api/field/{id}/summary" : {
+ "get" : {
+ "description" : "Get the count and distinct count of `Field` with ID.",
+ "operationId" : "get-api-field-id-summary",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "job-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -27605,15 +35902,18 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/transform-job/{job-id}",
- "tags" : [ "/api/ee/transform-job" ]
- },
+ "summary" : "GET /api/field/{id}/summary",
+ "tags" : [ "/api/field" ]
+ }
+ },
+ "/api/field/{id}/values" : {
"get" : {
- "description" : "Get a transform job by ID.",
+ "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.",
+ "operationId" : "get-api-field-id-values",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "job-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -27631,15 +35931,16 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/transform-job/{job-id}",
- "tags" : [ "/api/ee/transform-job" ]
+ "summary" : "GET /api/field/{id}/values",
+ "tags" : [ "/api/field" ]
},
- "put" : {
- "description" : "Update a transform job.",
+ "post" : {
+ "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.",
+ "operationId" : "post-api-field-id-values",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "job-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -27651,35 +35952,23 @@
"application/json" : {
"schema" : {
"properties" : {
- "description" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "schedule" : {
- "minLength" : 1,
- "type" : "string"
- },
- "tag_ids" : {
+ "values" : {
"items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "anyOf" : [ {
+ "prefixItems" : [ { } ],
+ "type" : "array"
+ }, {
+ "prefixItems" : [ { }, {
+ "minLength" : 1,
+ "type" : "string"
+ } ],
+ "type" : "array"
+ } ]
},
"type" : "array"
- },
- "ui_display_type" : {
- "enum" : [ "cron/raw", "cron/builder" ],
- "type" : "string"
}
},
+ "required" : [ "values" ],
"type" : "object"
}
}
@@ -27696,21 +35985,21 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/transform-job/{job-id}",
- "tags" : [ "/api/ee/transform-job" ]
+ "summary" : "POST /api/field/{id}/values",
+ "tags" : [ "/api/field" ]
}
},
- "/api/ee/transform-job/{job-id}/run" : {
- "post" : {
- "description" : "Run a transform job manually.",
+ "/api/geojson" : {
+ "get" : {
+ "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.",
+ "operationId" : "get-api-geojson",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "job-id",
+ "in" : "query",
+ "name" : "url",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "minLength" : 1,
+ "type" : "string"
}
} ],
"responses" : {
@@ -27724,21 +36013,21 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/transform-job/{job-id}/run",
- "tags" : [ "/api/ee/transform-job" ]
+ "summary" : "GET /api/geojson",
+ "tags" : [ "/api/geojson" ]
}
},
- "/api/ee/transform-job/{job-id}/transforms" : {
+ "/api/geojson/{key}" : {
"get" : {
- "description" : "Get the transforms of job specified by the job's ID.",
+ "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`).",
+ "operationId" : "get-api-geojson-key",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "job-id",
+ "name" : "key",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "minLength" : 1,
+ "type" : "string"
}
} ],
"responses" : {
@@ -27752,13 +36041,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/transform-job/{job-id}/transforms",
- "tags" : [ "/api/ee/transform-job" ]
+ "summary" : "GET /api/geojson/{key}",
+ "tags" : [ "/api/geojson" ]
}
},
- "/api/ee/transform-tag/" : {
+ "/api/glossary" : {
"get" : {
- "description" : "Get a list of all transform tags.",
+ "description" : "Fetch all glossary entries, optionally filtered by search term.",
+ "operationId" : "get-api-glossary",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -27771,23 +36061,28 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/transform-tag/",
- "tags" : [ "/api/ee/transform-tag" ]
+ "summary" : "GET /api/glossary",
+ "tags" : [ "/api/glossary" ]
},
"post" : {
- "description" : "Create a new transform tag.",
+ "description" : "Create a new glossary entry.",
+ "operationId" : "post-api-glossary",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "name" : {
+ "definition" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "term" : {
"minLength" : 1,
"type" : "string"
}
},
- "required" : [ "name" ],
+ "required" : [ "term", "definition" ],
"type" : "object"
}
}
@@ -27804,17 +36099,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/transform-tag/",
- "tags" : [ "/api/ee/transform-tag" ]
+ "summary" : "POST /api/glossary",
+ "tags" : [ "/api/glossary" ]
}
},
- "/api/ee/transform-tag/{tag-id}" : {
+ "/api/glossary/{id}" : {
"delete" : {
- "description" : "Delete a transform tag. Removes it from all transforms and jobs.",
+ "description" : "Delete a glossary entry.",
+ "operationId" : "delete-api-glossary-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "tag-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -27832,15 +36128,16 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/transform-tag/{tag-id}",
- "tags" : [ "/api/ee/transform-tag" ]
+ "summary" : "DELETE /api/glossary/{id}",
+ "tags" : [ "/api/glossary" ]
},
"put" : {
- "description" : "Update a transform tag.",
+ "description" : "Update an existing glossary entry.",
+ "operationId" : "put-api-glossary-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "tag-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -27852,12 +36149,16 @@
"application/json" : {
"schema" : {
"properties" : {
- "name" : {
+ "definition" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "term" : {
"minLength" : 1,
"type" : "string"
}
},
- "required" : [ "name" ],
+ "required" : [ "term", "definition" ],
"type" : "object"
}
}
@@ -27874,117 +36175,42 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/transform-tag/{tag-id}",
- "tags" : [ "/api/ee/transform-tag" ]
+ "summary" : "PUT /api/glossary/{id}",
+ "tags" : [ "/api/glossary" ]
}
},
- "/api/ee/transform/" : {
- "get" : {
- "description" : "Get a list of transforms.",
- "parameters" : [ {
- "in" : "query",
- "name" : "last_run_start_time",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "last_run_statuses",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "enum" : [ "started", "succeeded", "failed", "timeout" ],
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "tag_ids",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/ee/transform/",
- "tags" : [ "/api/ee/transform" ]
- },
- "post" : {
- "description" : "Create a new transform.",
+ "/api/google/settings" : {
+ "put" : {
+ "description" : "Update Google Sign-In related settings. You must be a superuser to do this.",
+ "operationId" : "put-api-google-settings",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "collection_id" : {
+ "google-auth-auto-create-accounts-domain" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "google-auth-client-id" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "name" : {
- "type" : "string"
- },
- "run_trigger" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.api.run-trigger"
- },
- "source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-source"
- },
- "tag_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
- },
- "target" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-target"
+ "google-auth-enabled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "name", "source", "target" ],
"type" : "object"
}
}
@@ -28001,24 +36227,50 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/transform/",
- "tags" : [ "/api/ee/transform" ]
+ "summary" : "PUT /api/google/settings",
+ "tags" : [ "/api/google" ]
}
},
- "/api/ee/transform/extract-columns" : {
- "post" : {
- "description" : "Extract column names from an MBQL query without executing it.\n\n Compiles the query to native SQL using [[qp.compile/compile-with-inline-parameters]],\n which handles parameterized queries with template tags. Then extracts column names\n using PreparedStatement metadata.\n\n Returns a map with a :columns key containing a vector of column names (strings).\n If extraction fails, returns nil for :columns.",
+ "/api/ldap/settings" : {
+ "put" : {
+ "description" : "Update LDAP related settings. You must be a superuser to do this.",
+ "operationId" : "put-api-ldap-settings",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "query" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.any-query"
+ "ldap-enabled" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-host" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-password" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ldap-port" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "query" ],
"type" : "object"
}
}
@@ -28035,24 +36287,29 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/transform/extract-columns",
- "tags" : [ "/api/ee/transform" ]
+ "summary" : "PUT /api/ldap/settings",
+ "tags" : [ "/api/ldap" ]
}
},
- "/api/ee/transform/is-simple-query" : {
+ "/api/llm/extract-tables" : {
"post" : {
- "description" : "Checks if a native SQL query string is simple enough for automatic checkpoint insertion",
+ "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-llm-extract-tables",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "query" : {
+ "database_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "sql" : {
"type" : "string"
}
},
- "required" : [ "query" ],
+ "required" : [ "database_id", "sql" ],
"type" : "object"
}
}
@@ -28060,6 +36317,102 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "tables" : {
+ "items" : {
+ "properties" : {
+ "columns" : {
+ "items" : {
+ "properties" : {
+ "database_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target" : {
+ "properties" : {
+ "field_name" : {
+ "type" : "string"
+ },
+ "table_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_name", "field_name" ],
+ "type" : "object"
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "columns" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "tables" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -28069,329 +36422,157 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/transform/is-simple-query",
- "tags" : [ "/api/ee/transform" ]
- }
- },
- "/api/ee/transform/run" : {
- "get" : {
- "description" : "Get transform runs based on a set of filter params.",
- "parameters" : [ {
- "in" : "query",
- "name" : "sort_column",
- "required" : false,
- "schema" : {
- "enum" : [ "started_at", "ended_at" ],
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "sort_direction",
- "required" : false,
- "schema" : {
- "enum" : [ "asc", "desc" ],
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "transform_ids",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "statuses",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "enum" : [ "started", "succeeded", "failed", "timeout" ],
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "transform_tag_ids",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "minimum" : 0,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "start_time",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "end_time",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "run_methods",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "enum" : [ "manual", "cron" ],
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/ee/transform/run",
- "tags" : [ "/api/ee/transform" ]
+ "summary" : "POST /api/llm/extract-tables",
+ "tags" : [ "/api/llm" ]
}
},
- "/api/ee/transform/{id}" : {
- "delete" : {
- "description" : "Delete a transform.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "DELETE /api/ee/transform/{id}",
- "tags" : [ "/api/ee/transform" ]
- },
- "get" : {
- "description" : "Get a specific transform.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/ee/transform/{id}",
- "tags" : [ "/api/ee/transform" ]
- },
- "put" : {
- "description" : "Update a transform.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "/api/llm/generate-sql" : {
+ "post" : {
+ "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-llm-generate-sql",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "database_id" : {
+ "minimum" : 1,
+ "type" : "integer"
},
- "name" : {
+ "prompt" : {
"type" : "string"
},
- "run_trigger" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.api.run-trigger"
- },
- "source" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-source"
- },
- "tag_ids" : {
+ "referenced_entities" : {
"items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "properties" : {
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "model" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "model", "id" ],
+ "type" : "object"
},
"type" : "array"
},
- "target" : {
- "$ref" : "#/components/schemas/metabase-enterprise.transforms.schema.transform-target"
+ "source_sql" : {
+ "type" : "string"
}
},
+ "required" : [ "prompt", "database_id" ],
"type" : "object"
}
}
}
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "PUT /api/ee/transform/{id}",
- "tags" : [ "/api/ee/transform" ]
- }
- },
- "/api/ee/transform/{id}/cancel" : {
- "post" : {
- "description" : "Cancel the current run for a given transform.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/ee/transform/{id}/cancel",
- "tags" : [ "/api/ee/transform" ]
- }
- },
- "/api/ee/transform/{id}/dependencies" : {
- "get" : {
- "description" : "Get the dependencies of a specific transform.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/ee/transform/{id}/dependencies",
- "tags" : [ "/api/ee/transform" ]
- }
- },
- "/api/ee/transform/{id}/run" : {
- "post" : {
- "description" : "Run a transform.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "referenced_entities" : {
+ "items" : {
+ "properties" : {
+ "columns" : {
+ "items" : {
+ "properties" : {
+ "database_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "fk_target" : {
+ "properties" : {
+ "field_name" : {
+ "type" : "string"
+ },
+ "table_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "table_name", "field_name" ],
+ "type" : "object"
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "model" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "model", "id", "name", "columns" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "sql" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "sql", "referenced_entities" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -28401,25 +36582,42 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/transform/{id}/run",
- "tags" : [ "/api/ee/transform" ]
+ "summary" : "POST /api/llm/generate-sql",
+ "tags" : [ "/api/llm" ]
}
},
- "/api/ee/transform/{id}/table" : {
- "delete" : {
- "description" : "Delete a transform's output table.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "/api/llm/list-models" : {
+ "get" : {
+ "description" : "List available LLM models from the configured provider.\n\n Requires LLM to be configured (Anthropic API key set in admin settings).",
+ "operationId" : "get-api-llm-list-models",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "models" : {
+ "items" : {
+ "properties" : {
+ "display_name" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "display_name" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "models" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -28429,22 +36627,15 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/transform/{id}/table",
- "tags" : [ "/api/ee/transform" ]
+ "summary" : "GET /api/llm/list-models",
+ "tags" : [ "/api/llm" ]
}
},
- "/api/ee/transforms-python/library/{path}" : {
- "get" : {
- "description" : "Get the Python library for user modules.",
- "parameters" : [ {
- "in" : "path",
- "name" : "path",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- } ],
+ "/api/logger/adjustment" : {
+ "delete" : {
+ "description" : "Undo any log level adjustments.",
+ "operationId" : "delete-api-logger-adjustment",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -28456,31 +36647,27 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/transforms-python/library/{path}",
- "tags" : [ "/api/ee/transforms-python" ]
+ "summary" : "DELETE /api/logger/adjustment",
+ "tags" : [ "/api/logger" ]
},
- "put" : {
- "description" : "Update the Python library source code for user modules.",
- "parameters" : [ {
- "in" : "path",
- "name" : "path",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- } ],
+ "post" : {
+ "description" : "Temporarily adjust the log levels.",
+ "operationId" : "post-api-logger-adjustment",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "additionalProperties" : false,
"properties" : {
- "source" : {
- "type" : "string"
- }
+ "duration" : {
+ "type" : "integer"
+ },
+ "duration_unit" : {
+ "$ref" : "#/components/schemas/metabase.logger.api.time-unit"
+ },
+ "log_levels" : { }
},
- "required" : [ "source" ],
+ "required" : [ "duration", "duration_unit", "log_levels" ],
"type" : "object"
}
}
@@ -28497,100 +36684,68 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ee/transforms-python/library/{path}",
- "tags" : [ "/api/ee/transforms-python" ]
+ "summary" : "POST /api/logger/adjustment",
+ "tags" : [ "/api/logger" ]
}
},
- "/api/ee/transforms-python/test-run" : {
- "post" : {
- "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.",
+ "/api/logger/logs" : {
+ "get" : {
+ "description" : "Logs.",
+ "operationId" : "get-api-logger-logs",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "code" : {
- "type" : "string"
- },
- "output_row_limit" : {
- "allOf" : [ {
- "type" : "integer"
- }, {
- "exclusiveMinimum" : 1,
- "type" : "number"
- }, {
- "maximum" : 100,
- "type" : "number"
- } ]
- },
- "per_input_row_limit" : {
- "allOf" : [ {
- "type" : "integer"
- }, {
- "exclusiveMinimum" : 1,
- "type" : "number"
- }, {
- "maximum" : 100,
- "type" : "number"
- } ]
- },
- "source_tables" : {
- "additionalProperties" : {
- "type" : "integer"
- },
- "type" : "object"
- }
- },
- "required" : [ "code", "source_tables" ],
- "type" : "object"
- }
- }
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/logger/logs",
+ "tags" : [ "/api/logger" ]
+ }
+ },
+ "/api/logger/presets" : {
+ "get" : {
+ "description" : "Get all known presets.",
+ "operationId" : "get-api-logger-presets",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "error" : {
- "properties" : {
- "message" : {
- "anyOf" : [ { }, { } ]
- }
+ "items" : {
+ "properties" : {
+ "display_name" : {
+ "type" : "string"
},
- "required" : [ "message" ],
- "type" : "object"
- },
- "logs" : {
- "type" : "string"
- },
- "output" : {
- "properties" : {
- "cols" : {
- "items" : {
- "properties" : {
- "name" : {
- "type" : "string"
- }
+ "id" : {
+ "type" : "string"
+ },
+ "loggers" : {
+ "items" : {
+ "properties" : {
+ "level" : {
+ "$ref" : "#/components/schemas/metabase.logger.api.log-level"
},
- "required" : [ "name" ],
- "type" : "object"
+ "name" : {
+ "type" : "string"
+ }
},
- "type" : "array"
+ "required" : [ "name", "level" ],
+ "type" : "object"
},
- "rows" : {
- "items" : { },
- "type" : "array"
- }
- },
- "required" : [ "cols", "rows" ],
- "type" : "object"
- }
+ "type" : "array"
+ }
+ },
+ "required" : [ "id", "display_name", "loggers" ],
+ "type" : "object"
},
- "required" : [ "logs" ],
- "type" : "object"
+ "type" : "array"
}
}
},
@@ -28603,13 +36758,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/ee/transforms-python/test-run",
- "tags" : [ "/api/ee/transforms-python" ]
+ "summary" : "GET /api/logger/presets",
+ "tags" : [ "/api/logger" ]
}
},
- "/api/ee/upload-management/tables" : {
+ "/api/login-history/current" : {
"get" : {
- "description" : "Get all `Tables` visible to the current user which were created by uploading a file.",
+ "description" : "Fetch recent logins for the current user.",
+ "operationId" : "get-api-login-history-current",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -28622,37 +36778,27 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/ee/upload-management/tables",
- "tags" : [ "/api/ee/upload-management" ]
+ "summary" : "GET /api/login-history/current",
+ "tags" : [ "/api/login-history" ]
}
},
- "/api/ee/upload-management/tables/{id}" : {
- "delete" : {
- "description" : "Delete the uploaded table from the database, optionally archiving cards for which it is the primary source.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "archive-cards",
- "required" : false,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- } ],
+ "/api/measure" : {
+ "get" : {
+ "description" : "Fetch *all* `Measures`.",
+ "operationId" : "get-api-measure",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -28662,25 +36808,41 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/ee/upload-management/tables/{id}",
- "tags" : [ "/api/ee/upload-management" ]
- }
- },
- "/api/eid-translation/translate" : {
+ "summary" : "GET /api/measure",
+ "tags" : [ "/api/measure" ]
+ },
"post" : {
- "description" : "Translate entity IDs to model IDs.",
+ "description" : "Create a new `Measure`.",
+ "operationId" : "post-api-measure",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "entity_ids" : {
+ "definition" : {
+ "description" : "Value must be a map.",
"properties" : { },
"type" : "object"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "table_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}
},
- "required" : [ "entity_ids" ],
+ "required" : [ "name", "table_id", "definition" ],
"type" : "object"
}
}
@@ -28688,6 +36850,13 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -28697,16 +36866,33 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/eid-translation/translate",
- "tags" : [ "/api/eid-translation" ]
+ "summary" : "POST /api/measure",
+ "tags" : [ "/api/measure" ]
}
},
- "/api/email/" : {
- "delete" : {
- "description" : "Clear all email related settings. You must be a superuser or have `setting` permission to do this.",
- "parameters" : [ ],
+ "/api/measure/{id}" : {
+ "get" : {
+ "description" : "Fetch `Measure` with ID.",
+ "operationId" : "get-api-measure-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -28716,53 +36902,63 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/email/",
- "tags" : [ "/api/email" ]
+ "summary" : "GET /api/measure/{id}",
+ "tags" : [ "/api/measure" ]
},
"put" : {
- "description" : "Update multiple email Settings. You must be a superuser or have `setting` permission to do this.",
- "parameters" : [ ],
+ "description" : "Update a `Measure` with ID.",
+ "operationId" : "put-api-measure-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "email-smtp-host" : {
- "anyOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email-smtp-password" : {
- "anyOf" : [ {
- "type" : "string"
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "email-smtp-port" : {
- "anyOf" : [ {
- "type" : "integer"
+ "definition" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
}, {
"type" : "null"
} ]
},
- "email-smtp-security" : {
- "anyOf" : [ {
+ "description" : {
+ "oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "email-smtp-username" : {
- "anyOf" : [ {
+ "name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
} ]
+ },
+ "revision_message" : {
+ "minLength" : 1,
+ "type" : "string"
}
},
+ "required" : [ "revision_message" ],
"type" : "object"
}
}
@@ -28770,6 +36966,13 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.measure"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -28779,121 +36982,22 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/email/",
- "tags" : [ "/api/email" ]
- }
- },
- "/api/email/test" : {
- "post" : {
- "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"
- }
- },
- "summary" : "POST /api/email/test",
- "tags" : [ "/api/email" ]
- }
- },
- "/api/embed/card/{token}" : {
- "get" : {
- "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"
- }
- },
- "summary" : "GET /api/embed/card/{token}",
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/card/{token}/params/{param-key}/remapping" : {
- "get" : {
- "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" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/remapping",
- "tags" : [ "/api/embed" ]
+ "summary" : "PUT /api/measure/{id}",
+ "tags" : [ "/api/measure" ]
}
},
- "/api/embed/card/{token}/params/{param-key}/search/{prefix}" : {
+ "/api/model-index" : {
"get" : {
- "description" : "Embedded version of chain filter search endpoint.",
+ "description" : "Retrieve list of ModelIndex.",
+ "operationId" : "get-api-model-index",
"parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "prefix",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "model_id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -28907,29 +37011,32 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/search/{prefix}",
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/card/{token}/params/{param-key}/values" : {
- "get" : {
- "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" : {
- "minLength" : 1,
- "type" : "string"
+ "summary" : "GET /api/model-index",
+ "tags" : [ "/api/model-index" ]
+ },
+ "post" : {
+ "description" : "Create ModelIndex.",
+ "operationId" : "post-api-model-index",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "model_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "pk_ref" : { },
+ "value_ref" : { }
+ },
+ "required" : [ "model_id", "pk_ref", "value_ref" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -28941,19 +37048,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/card/{token}/params/{param-key}/values",
- "tags" : [ "/api/embed" ]
+ "summary" : "POST /api/model-index",
+ "tags" : [ "/api/model-index" ]
}
},
- "/api/embed/card/{token}/query" : {
- "get" : {
- "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>}",
+ "/api/model-index/{id}" : {
+ "delete" : {
+ "description" : "Delete ModelIndex.",
+ "operationId" : "delete-api-model-index-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "token",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -28967,42 +37077,20 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/card/{token}/query",
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/card/{token}/query/{export-format}" : {
+ "summary" : "DELETE /api/model-index/{id}",
+ "tags" : [ "/api/model-index" ]
+ },
"get" : {
- "description" : "Like `GET /api/embed/card/query`, but returns the results as a file in the specified format.",
+ "description" : "Retrieve ModelIndex.",
+ "operationId" : "get-api-model-index-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"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",
+ "name" : "id",
"required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -29016,21 +37104,54 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/card/{token}/query/{export-format}",
- "tags" : [ "/api/embed" ]
+ "summary" : "GET /api/model-index/{id}",
+ "tags" : [ "/api/model-index" ]
}
},
- "/api/embed/dashboard/{token}" : {
- "get" : {
- "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"
+ "/api/moderation-review" : {
+ "post" : {
+ "description" : "Create a new `ModerationReview`.",
+ "operationId" : "post-api-moderation-review",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "moderated_item_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "moderated_item_type" : {
+ "enum" : [ "card", "card", "dashboard", "dashboard" ]
+ },
+ "status" : {
+ "oneOf" : [ {
+ "oneOf" : [ {
+ "enum" : [ "verified" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "text" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "moderated_item_id", "moderated_item_type" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29042,37 +37163,39 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/dashboard/{token}",
- "tags" : [ "/api/embed" ]
+ "summary" : "POST /api/moderation-review",
+ "tags" : [ "/api/moderation-review" ]
}
},
- "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "/api/mt/gtap" : {
"get" : {
- "description" : "Fetch the results of running a Card belonging to a Dashboard using a JSON Web Token signed with the\n `embedding-secret-key`",
+ "description" : "Fetch a list of all GTAPs currently in use, or a single GTAP if both `group_id` and `table_id` are provided.",
+ "operationId" : "get-api-mt-gtap",
"parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
+ "in" : "query",
+ "name" : "group_id",
+ "required" : false,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
+ "in" : "query",
+ "name" : "table_id",
+ "required" : false,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
@@ -29086,62 +37209,47 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
- "get" : {
- "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"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "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"
+ "summary" : "GET /api/mt/gtap",
+ "tags" : [ "/api/mt/gtap" ]
+ },
+ "post" : {
+ "description" : "Create a new GTAP.",
+ "operationId" : "post-api-mt-gtap",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "attribute_remappings" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.sandbox.schema.attribute-remappings"
+ },
+ "card_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "group_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "table_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "table_id", "group_id" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29153,29 +37261,41 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
- "tags" : [ "/api/embed" ]
+ "summary" : "POST /api/mt/gtap",
+ "tags" : [ "/api/mt/gtap" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/remapping" : {
- "get" : {
- "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" : {
- "minLength" : 1,
- "type" : "string"
+ "/api/mt/gtap/validate" : {
+ "post" : {
+ "description" : "Validate a sandbox which may not have yet been saved. This runs the same validation that is performed when the\n sandbox is saved, but doesn't actually save the sandbox.",
+ "operationId" : "post-api-mt-gtap-validate",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "card_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "table_id" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29187,35 +37307,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/remapping",
- "tags" : [ "/api/embed" ]
+ "summary" : "POST /api/mt/gtap/validate",
+ "tags" : [ "/api/mt/gtap" ]
}
},
- "/api/embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
- "get" : {
- "description" : "Embedded version of chain filter search endpoint.",
+ "/api/mt/gtap/{id}" : {
+ "delete" : {
+ "description" : "Delete a GTAP entry.",
+ "operationId" : "delete-api-mt-gtap-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "prefix",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -29229,27 +37336,20 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/search/{prefix}",
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/dashboard/{token}/params/{param-key}/values" : {
+ "summary" : "DELETE /api/mt/gtap/{id}",
+ "tags" : [ "/api/mt/gtap" ]
+ },
"get" : {
- "description" : "Embedded version of chain filter values endpoint.",
+ "description" : "Fetch GTAP by `id`",
+ "operationId" : "get-api-mt-gtap-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -29263,21 +37363,45 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/dashboard/{token}/params/{param-key}/values",
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/pivot/card/{token}/query" : {
- "get" : {
- "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>}",
+ "summary" : "GET /api/mt/gtap/{id}",
+ "tags" : [ "/api/mt/gtap" ]
+ },
+ "put" : {
+ "description" : "Update a GTAP entry. The only things you're allowed to update for a GTAP are the Card being used (`card_id`) or the\n parameter mappings; changing `table_id` or `group_id` would effectively be deleting this entry and creating a new\n one. If that's what you want to do, do so explicitly with appropriate calls to the `DELETE` and `POST` endpoints.",
+ "operationId" : "put-api-mt-gtap-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "token",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "attribute_remappings" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.sandbox.schema.attribute-remappings"
+ },
+ "card_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29289,39 +37413,64 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/pivot/card/{token}/query",
- "tags" : [ "/api/embed" ]
+ "summary" : "PUT /api/mt/gtap/{id}",
+ "tags" : [ "/api/mt/gtap" ]
}
},
- "/api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "/api/mt/user/attributes" : {
"get" : {
- "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"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "description" : "Fetch a list of possible keys for User `login_attributes`. This includes keys from tenant model\n attributes and keys that have already been set for existing Users.",
+ "operationId" : "get-api-mt-user-attributes",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- }, {
+ },
+ "summary" : "GET /api/mt/user/attributes",
+ "tags" : [ "/api/mt/user" ]
+ }
+ },
+ "/api/mt/user/{id}/attributes" : {
+ "put" : {
+ "description" : "Update the `login_attributes` for a User.",
+ "operationId" : "put-api-mt-user-id-attributes",
+ "parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "login_attributes" : {
+ "oneOf" : [ {
+ "additionalProperties" : { },
+ "description" : "value must be a valid user attributes map (name -> value)",
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29333,65 +37482,25 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "tags" : [ "/api/embed" ]
+ "summary" : "PUT /api/mt/user/{id}/attributes",
+ "tags" : [ "/api/mt/user" ]
}
},
- "/api/embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
+ "/api/native-query-snippet" : {
"get" : {
- "description" : "Generates a single tile image for an embedded Card using the map visualization.",
+ "description" : "Fetch all snippets",
+ "operationId" : "get-api-native-query-snippet",
"parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer.",
- "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 a valid JSON string.",
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "latField",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
"in" : "query",
- "name" : "lonField",
+ "name" : "archived",
"required" : true,
"schema" : {
- "type" : "string"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
@@ -29405,85 +37514,47 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/tiles/card/{token}/{zoom}/{x}/{y}",
- "tags" : [ "/api/embed" ]
- }
- },
- "/api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
- "get" : {
- "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer.",
- "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 a valid JSON string.",
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "latField",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "lonField",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "summary" : "GET /api/native-query-snippet",
+ "tags" : [ "/api/native-query-snippet" ]
+ },
+ "post" : {
+ "description" : "Create a new `NativeQuerySnippet`.",
+ "operationId" : "post-api-native-query-snippet",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "content" : {
+ "type" : "string"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "description" : "snippet names cannot include '}' or start with spaces"
+ }
+ },
+ "required" : [ "content", "name" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29495,13 +37566,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
- "tags" : [ "/api/embed" ]
+ "summary" : "POST /api/native-query-snippet",
+ "tags" : [ "/api/native-query-snippet" ]
}
},
- "/api/field/{id}" : {
+ "/api/native-query-snippet/{id}" : {
"get" : {
- "description" : "Get `Field` with ID.",
+ "description" : "Fetch native query snippet with ID.",
+ "operationId" : "get-api-native-query-snippet-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -29511,14 +37583,6 @@
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "include_editable_data_model",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
} ],
"responses" : {
"2XX" : {
@@ -29531,11 +37595,12 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/field/{id}",
- "tags" : [ "/api/field" ]
+ "summary" : "GET /api/native-query-snippet/{id}",
+ "tags" : [ "/api/native-query-snippet" ]
},
"put" : {
- "description" : "Update `Field` with ID.",
+ "description" : "Update an existing `NativeQuerySnippet`.",
+ "operationId" : "put-api-native-query-snippet-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -29551,38 +37616,14 @@
"application/json" : {
"schema" : {
"properties" : {
- "caveats" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "coercion_strategy" : {
- "oneOf" : [ {
- "description" : "value must be a valid coercion strategy (keyword or string)."
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
+ "archived" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "fk_target_field_id" : {
+ "collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
@@ -29591,59 +37632,23 @@
"type" : "null"
} ]
},
- "has_field_values" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.has-field-values"
- }, {
- "type" : "null"
- } ]
- },
- "json_unfolding" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "nfc_path" : {
- "oneOf" : [ {
- "items" : {
- "minLength" : 1,
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "points_of_interest" : {
+ "content" : {
"oneOf" : [ {
- "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
} ]
},
- "semantic_type" : {
- "oneOf" : [ {
- "description" : "value must be a valid field semantic or relation type (keyword or string)."
- }, {
- "type" : "null"
- } ]
- },
- "settings" : {
+ "description" : {
"oneOf" : [ {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "visibility_type" : {
+ "name" : {
"oneOf" : [ {
- "enum" : [ "retired", "sensitive", "normal", "hidden", "details-only" ],
- "type" : "string"
+ "description" : "snippet names cannot include '}' or start with spaces"
}, {
"type" : "null"
} ]
@@ -29665,22 +37670,69 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/field/{id}",
- "tags" : [ "/api/field" ]
+ "summary" : "PUT /api/native-query-snippet/{id}",
+ "tags" : [ "/api/native-query-snippet" ]
}
},
- "/api/field/{id}/dimension" : {
- "delete" : {
- "description" : "Remove the dimension associated to field at ID",
+ "/api/notification" : {
+ "get" : {
+ "description" : "List notifications.\n - `creator_id`: if provided returns only notifications created by this user\n - `recipient_id`: if provided returns only notification that has recipient_id as a recipient\n - `creator_or_recipient_id`: if provided returns only notification that has user_id as creator or recipient\n - `card_id`: if provided returns only notification that has card_id as payload",
+ "operationId" : "get-api-notification",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
+ "in" : "query",
+ "name" : "creator_id",
+ "required" : false,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "recipient_id",
+ "required" : false,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "creator_or_recipient_id",
+ "required" : false,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "card_id",
+ "required" : false,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "query",
+ "name" : "include_inactive",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "payload_type",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -29693,50 +37745,166 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/field/{id}/dimension",
- "tags" : [ "/api/field" ]
+ "summary" : "GET /api/notification",
+ "tags" : [ "/api/notification" ]
},
"post" : {
- "description" : "Sets the dimension for the given field at ID",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "description" : "Create a new notification, return the created notification.",
+ "operationId" : "post-api-notification",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.notification.api.notification.NotificationApiInput"
+ }
+ }
}
- } ],
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/notification",
+ "tags" : [ "/api/notification" ]
+ }
+ },
+ "/api/notification/send" : {
+ "post" : {
+ "description" : "Send an unsaved notification.",
+ "operationId" : "post-api-notification-send",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.notification.api.notification.NotificationApiInput"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/notification/send",
+ "tags" : [ "/api/notification" ]
+ }
+ },
+ "/api/notification/unsubscribe" : {
+ "post" : {
+ "description" : "Allow non-users to unsubscribe from notifications, with the hash given through email.",
+ "operationId" : "post-api-notification-unsubscribe",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "human_readable_field_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "email" : {
+ "type" : "string"
},
- "name" : {
- "minLength" : 1,
+ "hash" : {
"type" : "string"
},
- "type" : {
- "enum" : [ "internal", "external" ],
+ "notification-handler-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "notification-handler-id", "email", "hash" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/notification/unsubscribe",
+ "tags" : [ "/api/notification/unsubscribe" ]
+ }
+ },
+ "/api/notification/unsubscribe/undo" : {
+ "post" : {
+ "description" : "Allow non-users to undo an unsubscribe from notifications, with the hash given through email.",
+ "operationId" : "post-api-notification-unsubscribe-undo",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "email" : {
"type" : "string"
+ },
+ "hash" : {
+ "type" : "string"
+ },
+ "notification-handler-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}
},
- "required" : [ "type", "name" ],
+ "required" : [ "notification-handler-id", "email", "hash" ],
"type" : "object"
}
}
}
- },
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/notification/unsubscribe/undo",
+ "tags" : [ "/api/notification/unsubscribe" ]
+ }
+ },
+ "/api/notification/{id}" : {
+ "get" : {
+ "description" : "Get a notification by id.",
+ "operationId" : "get-api-notification-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29748,13 +37916,12 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/field/{id}/dimension",
- "tags" : [ "/api/field" ]
- }
- },
- "/api/field/{id}/discard_values" : {
- "post" : {
- "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.",
+ "summary" : "GET /api/notification/{id}",
+ "tags" : [ "/api/notification" ]
+ },
+ "put" : {
+ "description" : "Update a notification, can also update its subscriptions, handlers.\n Return the updated notification.",
+ "operationId" : "put-api-notification-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -29765,6 +37932,15 @@
"type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.notification.api.notification.NotificationApiInput"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29776,13 +37952,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/field/{id}/discard_values",
- "tags" : [ "/api/field" ]
+ "summary" : "PUT /api/notification/{id}",
+ "tags" : [ "/api/notification" ]
}
},
- "/api/field/{id}/related" : {
- "get" : {
- "description" : "Return related entities.",
+ "/api/notification/{id}/send" : {
+ "post" : {
+ "description" : "Send a notification by id.",
+ "operationId" : "post-api-notification-id-send",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -29793,6 +37970,25 @@
"type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "handler_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29804,13 +38000,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/field/{id}/related",
- "tags" : [ "/api/field" ]
+ "summary" : "POST /api/notification/{id}/send",
+ "tags" : [ "/api/notification" ]
}
},
- "/api/field/{id}/remapping/{remapped-id}" : {
- "get" : {
- "description" : "Fetch remapped Field values.",
+ "/api/notification/{id}/unsubscribe" : {
+ "post" : {
+ "description" : "Unsubscribe current user from a notification.",
+ "operationId" : "post-api-notification-id-unsubscribe",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -29820,23 +38017,6 @@
"minimum" : 1,
"type" : "integer"
}
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "remapped-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
} ],
"responses" : {
"2XX" : {
@@ -29849,23 +38029,50 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/field/{id}/remapping/{remapped-id}",
- "tags" : [ "/api/field" ]
+ "summary" : "POST /api/notification/{id}/unsubscribe",
+ "tags" : [ "/api/notification" ]
}
},
- "/api/field/{id}/rescan_values" : {
+ "/api/notify/db/attached_datawarehouse" : {
"post" : {
- "description" : "Manually trigger an update for the FieldValues for this Field. Only applies to Fields that are eligible for\n FieldValues.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "description" : "Sync the attached datawarehouse. Can provide in the body:\n - table_name and schema_name: both strings. Will look for an existing table and sync it, otherwise will try to find a\n new table with that name and sync it. If it cannot find a table it will throw an error. If table_name is empty or\n blank, will sync the entire database.\n - synchronous?: is a boolean value to indicate if this should block on the result.",
+ "operationId" : "post-api-notify-db-attached_datawarehouse",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "schema_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "synchronous?" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "synchronous?" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29877,13 +38084,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/field/{id}/rescan_values",
- "tags" : [ "/api/field" ]
+ "summary" : "POST /api/notify/db/attached_datawarehouse",
+ "tags" : [ "/api/notify" ]
}
},
- "/api/field/{id}/search/{search-id}" : {
- "get" : {
- "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.",
+ "/api/notify/db/{id}" : {
+ "post" : {
+ "description" : "Notification about a potential schema change to one of our `Databases`.\n Caller can optionally specify a `:table_id` or `:table_name` in the body to limit updates to a single\n `Table`. Optional Parameter `:scan` can be `\"full\"` or `\"schema\"` for a full sync or a schema sync, available\n regardless if a `:table_id` or `:table_name` is passed.\n This endpoint is secured by an API key that needs to be passed as a `X-METABASE-APIKEY` header which needs to be defined in\n the `MB_API_KEY` [environment variable](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables.html#mb_api_key)",
+ "operationId" : "post-api-notify-db-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -29893,24 +38101,43 @@
"minimum" : 1,
"type" : "integer"
}
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "search-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "value",
- "required" : false,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "scan" : {
+ "oneOf" : [ {
+ "enum" : [ "full", "schema" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29922,13 +38149,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/field/{id}/search/{search-id}",
- "tags" : [ "/api/field" ]
+ "summary" : "POST /api/notify/db/{id}",
+ "tags" : [ "/api/notify" ]
}
},
- "/api/field/{id}/summary" : {
- "get" : {
- "description" : "Get the count and distinct count of `Field` with ID.",
+ "/api/notify/db/{id}/new-table" : {
+ "post" : {
+ "description" : "Sync a new table without running a full database sync. Requires `schema_name` and `table_name`. Will throw an error\n if the table already exists in Metabase or cannot be found.",
+ "operationId" : "post-api-notify-db-id-new-table",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -29939,6 +38167,26 @@
"type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "schema_name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "table_name" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "schema_name", "table_name" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29950,23 +38198,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/field/{id}/summary",
- "tags" : [ "/api/field" ]
+ "summary" : "POST /api/notify/db/{id}/new-table",
+ "tags" : [ "/api/notify" ]
}
},
- "/api/field/{id}/values" : {
+ "/api/permissions/graph" : {
"get" : {
- "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" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "Fetch a graph of all Permissions.",
+ "operationId" : "get-api-permissions-graph",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29978,43 +38218,42 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/field/{id}/values",
- "tags" : [ "/api/field" ]
+ "summary" : "GET /api/permissions/graph",
+ "tags" : [ "/api/permissions" ]
},
- "post" : {
- "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.",
+ "put" : {
+ "description" : "Do a batch update of Permissions by passing in a modified graph. This should return the same graph, in the same\n format, that you got from `GET /api/permissions/graph`, with any changes made in the wherever necessary. This\n modified graph must correspond to the `PermissionsGraph` schema. If successful, this endpoint returns the updated\n permissions graph; use this as a base for any further modifications.\n\n Revisions to the permissions graph are tracked. If you fetch the permissions graph and some other third-party\n modifies it before you can submit you revisions, the endpoint will instead make no changes and return a\n 409 (Conflict) response. In this case, you should fetch the updated graph and make desired changes to that.\n\n The optional `sandboxes` key contains a list of sandboxes that should be created or modified in conjunction with\n this permissions graph update. Since data sandboxing is an Enterprise Edition-only feature, a 402 (Payment Required)\n response will be returned if this key is present and the server is not running the Enterprise Edition, and/or the\n `:sandboxes` feature flag is not present.\n\n If the skip-graph query param is truthy, then the graph will not be returned.",
+ "operationId" : "put-api-permissions-graph",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
+ "in" : "query",
+ "name" : "skip-graph",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "force",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "values" : {
- "items" : {
- "anyOf" : [ {
- "prefixItems" : [ { } ],
- "type" : "array"
- }, {
- "prefixItems" : [ { }, {
- "minLength" : 1,
- "type" : "string"
- } ],
- "type" : "array"
- } ]
- },
- "type" : "array"
- }
- },
- "required" : [ "values" ],
+ "properties" : { },
"type" : "object"
}
}
@@ -30031,20 +38270,22 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/field/{id}/values",
- "tags" : [ "/api/field" ]
+ "summary" : "PUT /api/permissions/graph",
+ "tags" : [ "/api/permissions" ]
}
},
- "/api/geojson/" : {
+ "/api/permissions/graph/db/{db-id}" : {
"get" : {
- "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.",
+ "description" : "Fetch a graph of all Permissions for db-id `db-id`.",
+ "operationId" : "get-api-permissions-graph-db-db-id",
"parameters" : [ {
- "in" : "query",
- "name" : "url",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "db-id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -30058,20 +38299,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/geojson/",
- "tags" : [ "/api/geojson" ]
+ "summary" : "GET /api/permissions/graph/db/{db-id}",
+ "tags" : [ "/api/permissions" ]
}
},
- "/api/geojson/{key}" : {
+ "/api/permissions/graph/group/{group-id}" : {
"get" : {
- "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`).",
+ "description" : "Fetch a graph of all Permissions for group-id `group-id`.",
+ "operationId" : "get-api-permissions-graph-group-group-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "key",
+ "name" : "group-id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -30085,14 +38328,23 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/geojson/{key}",
- "tags" : [ "/api/geojson" ]
+ "summary" : "GET /api/permissions/graph/group/{group-id}",
+ "tags" : [ "/api/permissions" ]
}
},
- "/api/glossary/" : {
+ "/api/permissions/group" : {
"get" : {
- "description" : "Fetch all glossary entries, optionally filtered by search term.",
- "parameters" : [ ],
+ "description" : "Fetch all `PermissionsGroups`, including a count of the number of `:members` in that group.\n This API requires superuser or group manager of more than one group.\n Group manager is only available if `advanced-permissions` is enabled and returns only groups that user\n is manager of.\n\n Optional query parameter `tenancy` can be used to filter groups:\n - `tenancy=external`: Returns only tenant groups (where `is_tenant_group = true`)\n - `tenancy=internal`: Returns only non-tenant groups (where `is_tenant_group = false`)\n - No `tenancy` parameter: Returns all groups (default behavior)",
+ "operationId" : "get-api-permissions-group",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "tenancy",
+ "required" : false,
+ "schema" : {
+ "enum" : [ "external", "internal" ],
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -30104,27 +38356,31 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/glossary/",
- "tags" : [ "/api/glossary" ]
+ "summary" : "GET /api/permissions/group",
+ "tags" : [ "/api/permissions" ]
},
"post" : {
- "description" : "Create a new glossary entry.",
+ "description" : "Create a new `PermissionsGroup`.",
+ "operationId" : "post-api-permissions-group",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "definition" : {
- "minLength" : 1,
- "type" : "string"
+ "is_tenant_group" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "term" : {
+ "name" : {
"minLength" : 1,
"type" : "string"
}
},
- "required" : [ "term", "definition" ],
+ "required" : [ "name" ],
"type" : "object"
}
}
@@ -30141,17 +38397,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/glossary/",
- "tags" : [ "/api/glossary" ]
+ "summary" : "POST /api/permissions/group",
+ "tags" : [ "/api/permissions" ]
}
},
- "/api/glossary/{id}" : {
+ "/api/permissions/group/{group-id}" : {
"delete" : {
- "description" : "Delete a glossary entry.",
+ "description" : "Delete a specific `PermissionsGroup`.",
+ "operationId" : "delete-api-permissions-group-group-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "group-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -30169,15 +38426,16 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/glossary/{id}",
- "tags" : [ "/api/glossary" ]
+ "summary" : "DELETE /api/permissions/group/{group-id}",
+ "tags" : [ "/api/permissions" ]
},
"put" : {
- "description" : "Update an existing glossary entry.",
+ "description" : "Update the name of a `PermissionsGroup`.",
+ "operationId" : "put-api-permissions-group-group-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "group-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -30189,16 +38447,12 @@
"application/json" : {
"schema" : {
"properties" : {
- "definition" : {
- "minLength" : 1,
- "type" : "string"
- },
- "term" : {
+ "name" : {
"minLength" : 1,
"type" : "string"
}
},
- "required" : [ "term", "definition" ],
+ "required" : [ "name" ],
"type" : "object"
}
}
@@ -30215,46 +38469,24 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/glossary/{id}",
- "tags" : [ "/api/glossary" ]
+ "summary" : "PUT /api/permissions/group/{group-id}",
+ "tags" : [ "/api/permissions" ]
}
},
- "/api/google/settings" : {
- "put" : {
- "description" : "Update Google Sign-In related settings. You must be a superuser to do this.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "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"
- } ]
- }
- },
- "type" : "object"
- }
- }
+ "/api/permissions/group/{id}" : {
+ "get" : {
+ "description" : "Fetch the details for a certain permissions group.",
+ "operationId" : "get-api-permissions-group-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -30266,49 +38498,58 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/google/settings",
- "tags" : [ "/api/google" ]
+ "summary" : "GET /api/permissions/group/{id}",
+ "tags" : [ "/api/permissions" ]
}
},
- "/api/ldap/settings" : {
- "put" : {
- "description" : "Update LDAP related settings. You must be a superuser to do this.",
+ "/api/permissions/membership" : {
+ "get" : {
+ "description" : "Fetch a map describing the group memberships of various users.\n This map's format is:\n\n {<user-id> [{:membership_id <id>\n :group_id <id>\n :is_group_manager boolean}]}",
+ "operationId" : "get-api-permissions-membership",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/permissions/membership",
+ "tags" : [ "/api/permissions" ]
+ },
+ "post" : {
+ "description" : "Add a `User` to a `PermissionsGroup`. Returns updated list of members belonging to the group.",
+ "operationId" : "post-api-permissions-membership",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "ldap-enabled" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "ldap-host" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "group_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
},
- "ldap-password" : {
+ "is_group_manager" : {
+ "default" : false,
"oneOf" : [ {
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "ldap-port" : {
- "oneOf" : [ {
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "user_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}
},
+ "required" : [ "group_id", "user_id", "is_group_manager" ],
"type" : "object"
}
}
@@ -30325,14 +38566,53 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/ldap/settings",
- "tags" : [ "/api/ldap" ]
+ "summary" : "POST /api/permissions/membership",
+ "tags" : [ "/api/permissions" ]
+ }
+ },
+ "/api/permissions/membership/{group-id}/clear" : {
+ "put" : {
+ "description" : "Remove all members from a `PermissionsGroup`. Returns a 400 (Bad Request) if the group ID is for the admin group.",
+ "operationId" : "put-api-permissions-membership-group-id-clear",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "group-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "PUT /api/permissions/membership/{group-id}/clear",
+ "tags" : [ "/api/permissions" ]
}
},
- "/api/logger/adjustment" : {
+ "/api/permissions/membership/{id}" : {
"delete" : {
- "description" : "Undo any log level adjustments.",
- "parameters" : [ ],
+ "description" : "Remove a User from a PermissionsGroup (delete their membership).",
+ "operationId" : "delete-api-permissions-membership-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -30344,26 +38624,32 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/logger/adjustment",
- "tags" : [ "/api/logger" ]
+ "summary" : "DELETE /api/permissions/membership/{id}",
+ "tags" : [ "/api/permissions" ]
},
- "post" : {
- "description" : "Temporarily adjust the log levels.",
- "parameters" : [ ],
+ "put" : {
+ "description" : "Update a Permission Group membership. Returns the updated record.",
+ "operationId" : "put-api-permissions-membership-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "duration" : {
- "type" : "integer"
- },
- "duration_unit" : {
- "$ref" : "#/components/schemas/metabase.logger.api.time-unit"
- },
- "log_levels" : { }
+ "is_group_manager" : {
+ "type" : "boolean"
+ }
},
- "required" : [ "duration", "duration_unit", "log_levels" ],
+ "required" : [ "is_group_manager" ],
"type" : "object"
}
}
@@ -30380,13 +38666,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/logger/adjustment",
- "tags" : [ "/api/logger" ]
+ "summary" : "PUT /api/permissions/membership/{id}",
+ "tags" : [ "/api/permissions" ]
}
},
- "/api/logger/logs" : {
+ "/api/persist" : {
"get" : {
- "description" : "Logs.",
+ "description" : "List the entries of [[PersistedInfo]] in order to show a status page.",
+ "operationId" : "get-api-persist",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -30399,50 +38686,26 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/logger/logs",
- "tags" : [ "/api/logger" ]
+ "summary" : "GET /api/persist",
+ "tags" : [ "/api/persist" ]
}
},
- "/api/logger/presets" : {
+ "/api/persist/card/{card-id}" : {
"get" : {
- "description" : "Get all known presets.",
- "parameters" : [ ],
+ "description" : "Fetch a particular [[PersistedInfo]] by card-id.",
+ "operationId" : "get-api-persist-card-card-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "items" : {
- "properties" : {
- "display_name" : {
- "type" : "string"
- },
- "id" : {
- "type" : "string"
- },
- "loggers" : {
- "items" : {
- "properties" : {
- "level" : {
- "$ref" : "#/components/schemas/metabase.logger.api.log-level"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "name", "level" ],
- "type" : "object"
- },
- "type" : "array"
- }
- },
- "required" : [ "id", "display_name", "loggers" ],
- "type" : "object"
- },
- "type" : "array"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -30452,14 +38715,24 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/logger/presets",
- "tags" : [ "/api/logger" ]
+ "summary" : "GET /api/persist/card/{card-id}",
+ "tags" : [ "/api/persist" ]
}
},
- "/api/login-history/current" : {
- "get" : {
- "description" : "Fetch recent logins for the current user.",
- "parameters" : [ ],
+ "/api/persist/card/{card-id}/persist" : {
+ "post" : {
+ "description" : "Mark the model (card) as persisted. Runs the query and saves it to the database backing the card and hot swaps this\n query in place of the model's query.",
+ "operationId" : "post-api-persist-card-card-id-persist",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -30471,26 +38744,26 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/login-history/current",
- "tags" : [ "/api/login-history" ]
+ "summary" : "POST /api/persist/card/{card-id}/persist",
+ "tags" : [ "/api/persist" ]
}
},
- "/api/measure/" : {
- "get" : {
- "description" : "Fetch *all* `Measures`.",
- "parameters" : [ ],
+ "/api/persist/card/{card-id}/refresh" : {
+ "post" : {
+ "description" : "Refresh the persisted model caching `card-id`.",
+ "operationId" : "post-api-persist-card-card-id-refresh",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.measures.api.measure"
- },
- "type" : "array"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -30500,54 +38773,26 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/measure/",
- "tags" : [ "/api/measure" ]
- },
+ "summary" : "POST /api/persist/card/{card-id}/refresh",
+ "tags" : [ "/api/persist" ]
+ }
+ },
+ "/api/persist/card/{card-id}/unpersist" : {
"post" : {
- "description" : "Create a new `Measure`.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "definition" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "table_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "name", "table_id", "definition" ],
- "type" : "object"
- }
- }
+ "description" : "Unpersist this model. Deletes the persisted table backing the model and all queries after this will use the card's\n query rather than the saved version of the query.",
+ "operationId" : "post-api-persist-card-card-id-unpersist",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
+ } ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.measures.api.measure"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -30557,13 +38802,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/measure/",
- "tags" : [ "/api/measure" ]
+ "summary" : "POST /api/persist/card/{card-id}/unpersist",
+ "tags" : [ "/api/persist" ]
}
},
- "/api/measure/{id}" : {
- "get" : {
- "description" : "Fetch `Measure` with ID.",
+ "/api/persist/database/{id}/persist" : {
+ "post" : {
+ "description" : "Attempt to enable model persistence for a database. If already enabled returns a generic 204.",
+ "operationId" : "post-api-persist-database-id-persist",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -30576,13 +38822,6 @@
} ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.measures.api.measure"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -30592,11 +38831,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/measure/{id}",
- "tags" : [ "/api/measure" ]
- },
- "put" : {
- "description" : "Update a `Measure` with ID.",
+ "summary" : "POST /api/persist/database/{id}/persist",
+ "tags" : [ "/api/persist" ]
+ }
+ },
+ "/api/persist/database/{id}/unpersist" : {
+ "post" : {
+ "description" : "Attempt to disable model persistence for a database. If already not enabled, just returns a generic 204.",
+ "operationId" : "post-api-persist-database-id-unpersist",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -30607,61 +38849,28 @@
"type" : "integer"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "definition" : {
- "oneOf" : [ {
- "properties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "revision_message" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "revision_message" ],
- "type" : "object"
- }
- }
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "POST /api/persist/database/{id}/unpersist",
+ "tags" : [ "/api/persist" ]
+ }
+ },
+ "/api/persist/disable" : {
+ "post" : {
+ "description" : "Disable global setting to allow databases to persist models. This will remove all tasks to refresh tables, remove\n that option from databases which might have it enabled, and delete all cached tables.",
+ "operationId" : "post-api-persist-disable",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.measures.api.measure"
- }
- }
- },
"description" : "Successful response"
},
"4XX" : {
@@ -30671,23 +38880,15 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/measure/{id}",
- "tags" : [ "/api/measure" ]
+ "summary" : "POST /api/persist/disable",
+ "tags" : [ "/api/persist" ]
}
},
- "/api/model-index/" : {
- "get" : {
- "description" : "Retrieve list of ModelIndex.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "query",
- "name" : "model_id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "/api/persist/enable" : {
+ "post" : {
+ "description" : "Enable global setting to allow databases to persist models.",
+ "operationId" : "post-api-persist-enable",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -30699,26 +38900,27 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/model-index/",
- "tags" : [ "/api/model-index" ]
- },
+ "summary" : "POST /api/persist/enable",
+ "tags" : [ "/api/persist" ]
+ }
+ },
+ "/api/persist/set-refresh-schedule" : {
"post" : {
- "description" : "Create ModelIndex.",
+ "description" : "Set the cron schedule to refresh persisted models.\n Shape should be JSON like {cron: \"0 30 1/8 * * ? *\"}.",
+ "operationId" : "post-api-persist-set-refresh-schedule",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "model_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "pk_ref" : { },
- "value_ref" : { }
+ "cron" : {
+ "description" : "Value must be a string representing a cron schedule of format <seconds> <minutes> <hours> <day of month> <month> <day of week> <year>",
+ "minLength" : 1,
+ "type" : "string"
+ }
},
- "required" : [ "model_id", "pk_ref", "value_ref" ],
+ "required" : [ "cron" ],
"type" : "object"
}
}
@@ -30735,17 +38937,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/model-index/",
- "tags" : [ "/api/model-index" ]
+ "summary" : "POST /api/persist/set-refresh-schedule",
+ "tags" : [ "/api/persist" ]
}
},
- "/api/model-index/{id}" : {
- "delete" : {
- "description" : "Delete ModelIndex.",
+ "/api/persist/{persisted-info-id}" : {
+ "get" : {
+ "description" : "Fetch a particular [[PersistedInfo]] by id.",
+ "operationId" : "get-api-persist-persisted-info-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "persisted-info-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -30763,21 +38966,15 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/model-index/{id}",
- "tags" : [ "/api/model-index" ]
- },
- "get" : {
- "description" : "Retrieve ModelIndex.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "summary" : "GET /api/persist/{persisted-info-id}",
+ "tags" : [ "/api/persist" ]
+ }
+ },
+ "/api/premium-features/token/refresh" : {
+ "post" : {
+ "description" : "Clear all token caches and re-check the premium features token against the MetaStore.\n Returns the fresh token status. Useful for the frontend after a purchase so that new features\n are recognized without waiting for the cache TTL.",
+ "operationId" : "post-api-premium-features-token-refresh",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -30789,53 +38986,42 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/model-index/{id}",
- "tags" : [ "/api/model-index" ]
+ "summary" : "POST /api/premium-features/token/refresh",
+ "tags" : [ "/api/premium-features" ]
}
},
- "/api/moderation-review/" : {
- "post" : {
- "description" : "Create a new `ModerationReview`.",
+ "/api/premium-features/token/status" : {
+ "get" : {
+ "description" : "Fetch info about the current Premium-Features premium features token including whether it is `valid`, a `trial` token, its\n `features`, when it is `valid-thru`, and the `status` of the account.",
+ "operationId" : "get-api-premium-features-token-status",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "moderated_item_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "moderated_item_type" : {
- "enum" : [ "card", "card", "dashboard", "dashboard" ]
- },
- "status" : {
- "oneOf" : [ {
- "oneOf" : [ {
- "enum" : [ "verified" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }, {
- "type" : "null"
- } ]
- },
- "text" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "moderated_item_id", "moderated_item_type" ],
- "type" : "object"
- }
- }
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/premium-features/token/status",
+ "tags" : [ "/api/premium-features" ]
+ }
+ },
+ "/api/preview_embed/card/{token}" : {
+ "get" : {
+ "description" : "Fetch a Card you're considering embedding by passing a JWT `token`.",
+ "operationId" : "get-api-preview_embed-card-token",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -30847,38 +39033,35 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/moderation-review/",
- "tags" : [ "/api/moderation-review" ]
+ "summary" : "GET /api/preview_embed/card/{token}",
+ "tags" : [ "/api/preview_embed" ]
}
},
- "/api/mt/gtap/" : {
+ "/api/preview_embed/card/{token}/params/{param-key}/remapping" : {
"get" : {
- "description" : "Fetch a list of all GTAPs currently in use, or a single GTAP if both `group_id` and `table_id` are provided.",
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "operationId" : "get-api-preview_embed-card-token-params-param-key-remapping",
"parameters" : [ {
- "in" : "query",
- "name" : "group_id",
- "required" : false,
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
}, {
- "in" : "query",
- "name" : "table_id",
- "required" : false,
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
} ],
"responses" : {
@@ -30892,48 +39075,58 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/mt/gtap/",
- "tags" : [ "/api/mt/gtap" ]
- },
- "post" : {
- "description" : "Create a new GTAP.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "attribute_remappings" : {
- "$ref" : "#/components/schemas/metabase-enterprise.sandbox.schema.attribute-remappings"
- },
- "card_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "group_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "table_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "table_id", "group_id" ],
- "type" : "object"
- }
- }
+ "summary" : "GET /api/preview_embed/card/{token}/params/{param-key}/remapping",
+ "tags" : [ "/api/preview_embed" ]
+ }
+ },
+ "/api/preview_embed/card/{token}/params/{param-key}/values" : {
+ "get" : {
+ "description" : "Embedded version of api.card filter values endpoint.",
+ "operationId" : "get-api-preview_embed-card-token-params-param-key-values",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
- },
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "has_more_values" : {
+ "type" : "boolean"
+ },
+ "values" : {
+ "items" : {
+ "anyOf" : [ {
+ "prefixItems" : [ { }, {
+ "type" : "string"
+ } ],
+ "type" : "array"
+ }, {
+ "prefixItems" : [ { } ],
+ "type" : "array"
+ } ]
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "has_more_values", "values" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -30943,40 +39136,22 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/mt/gtap/",
- "tags" : [ "/api/mt/gtap" ]
+ "summary" : "GET /api/preview_embed/card/{token}/params/{param-key}/values",
+ "tags" : [ "/api/preview_embed" ]
}
},
- "/api/mt/gtap/validate" : {
- "post" : {
- "description" : "Validate a sandbox which may not have yet been saved. This runs the same validation that is performed when the\n sandbox is saved, but doesn't actually save the sandbox.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "card_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "table_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "table_id" ],
- "type" : "object"
- }
- }
+ "/api/preview_embed/card/{token}/query" : {
+ "get" : {
+ "description" : "Fetch the query results for a Card you're considering embedding by passing a JWT `token`.",
+ "operationId" : "get-api-preview_embed-card-token-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
- },
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -30988,21 +39163,20 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/mt/gtap/validate",
- "tags" : [ "/api/mt/gtap" ]
+ "summary" : "GET /api/preview_embed/card/{token}/query",
+ "tags" : [ "/api/preview_embed" ]
}
},
- "/api/mt/gtap/{id}" : {
- "delete" : {
- "description" : "Delete a GTAP entry.",
+ "/api/preview_embed/dashboard/{token}" : {
+ "get" : {
+ "description" : "Fetch a Dashboard you're considering embedding by passing a JWT `token`. ",
+ "operationId" : "get-api-preview_embed-dashboard-token",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "token",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "type" : "string"
}
} ],
"responses" : {
@@ -31016,70 +39190,40 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/mt/gtap/{id}",
- "tags" : [ "/api/mt/gtap" ]
- },
+ "summary" : "GET /api/preview_embed/dashboard/{token}",
+ "tags" : [ "/api/preview_embed" ]
+ }
+ },
+ "/api/preview_embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
- "description" : "Fetch GTAP by `id`",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT `token`.",
+ "operationId" : "get-api-preview_embed-dashboard-token-dashcard-dashcard-id-card-card-id",
"parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/mt/gtap/{id}",
- "tags" : [ "/api/mt/gtap" ]
- },
- "put" : {
- "description" : "Update a GTAP entry. The only things you're allowed to update for a GTAP are the Card being used (`card_id`) or the\n parameter mappings; changing `table_id` or `group_id` would effectively be deleting this entry and creating a new\n one. If that's what you want to do, do so explicitly with appropriate calls to the `DELETE` and `POST` endpoints.",
- "parameters" : [ {
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "attribute_remappings" : {
- "$ref" : "#/components/schemas/metabase-enterprise.sandbox.schema.attribute-remappings"
- },
- "card_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31091,14 +39235,30 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/mt/gtap/{id}",
- "tags" : [ "/api/mt/gtap" ]
+ "summary" : "GET /api/preview_embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "tags" : [ "/api/preview_embed" ]
}
},
- "/api/mt/user/attributes" : {
+ "/api/preview_embed/dashboard/{token}/params/{param-key}/remapping" : {
"get" : {
- "description" : "Fetch a list of possible keys for User `login_attributes`. This includes keys from tenant model\n attributes and keys that have already been set for existing Users.",
- "parameters" : [ ],
+ "description" : "Embedded version of the remapped dashboard param value endpoint.",
+ "operationId" : "get-api-preview_embed-dashboard-token-params-param-key-remapping",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31110,43 +39270,38 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/mt/user/attributes",
- "tags" : [ "/api/mt/user" ]
+ "summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/remapping",
+ "tags" : [ "/api/preview_embed" ]
}
},
- "/api/mt/user/{id}/attributes" : {
- "put" : {
- "description" : "Update the `login_attributes` for a User.",
+ "/api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
+ "get" : {
+ "description" : "Embedded version of chain filter search endpoint.",
+ "operationId" : "get-api-preview_embed-dashboard-token-params-param-key-search-prefix",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "token",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "type" : "string"
}
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "login_attributes" : {
- "oneOf" : [ {
- "additionalProperties" : { },
- "description" : "value must be a valid user attributes map (name -> value)",
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
}
- },
+ }, {
+ "in" : "path",
+ "name" : "prefix",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31158,24 +39313,28 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/mt/user/{id}/attributes",
- "tags" : [ "/api/mt/user" ]
+ "summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}",
+ "tags" : [ "/api/preview_embed" ]
}
},
- "/api/native-query-snippet/" : {
+ "/api/preview_embed/dashboard/{token}/params/{param-key}/values" : {
"get" : {
- "description" : "Fetch all snippets",
+ "description" : "Embedded version of chain filter values endpoint.",
+ "operationId" : "get-api-preview_embed-dashboard-token-params-param-key-values",
"parameters" : [ {
- "in" : "query",
- "name" : "archived",
+ "in" : "path",
+ "name" : "token",
"required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
}
} ],
"responses" : {
@@ -31189,46 +39348,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/native-query-snippet/",
- "tags" : [ "/api/native-query-snippet" ]
- },
- "post" : {
- "description" : "Create a new `NativeQuerySnippet`.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "content" : {
- "type" : "string"
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "description" : "snippet names cannot include '}' or start with spaces"
- }
- },
- "required" : [ "content", "name" ],
- "type" : "object"
- }
- }
+ "summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/values",
+ "tags" : [ "/api/preview_embed" ]
+ }
+ },
+ "/api/preview_embed/pivot/card/{token}/query" : {
+ "get" : {
+ "description" : "Fetch the query results for a Card you're considering embedding by passing a JWT `token`.",
+ "operationId" : "get-api-preview_embed-pivot-card-token-query",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
- },
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31240,17 +39375,34 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/native-query-snippet/",
- "tags" : [ "/api/native-query-snippet" ]
+ "summary" : "GET /api/preview_embed/pivot/card/{token}/query",
+ "tags" : [ "/api/preview_embed" ]
}
},
- "/api/native-query-snippet/{id}" : {
+ "/api/preview_embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
- "description" : "Fetch native query snippet with ID.",
+ "description" : "Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT `token`.",
+ "operationId" : "get-api-preview_embed-pivot-dashboard-token-dashcard-dashcard-id-card-card-id",
"parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -31268,69 +39420,68 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/native-query-snippet/{id}",
- "tags" : [ "/api/native-query-snippet" ]
- },
- "put" : {
- "description" : "Update an existing `NativeQuerySnippet`.",
+ "summary" : "GET /api/preview_embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
+ "tags" : [ "/api/preview_embed" ]
+ }
+ },
+ "/api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
+ "get" : {
+ "description" : "Generates a single tile image for an embedded Card using the map visualization.",
+ "operationId" : "get-api-preview_embed-tiles-card-token-zoom-x-y",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "value must be an integer.",
+ "in" : "path",
+ "name" : "zoom",
"required" : true,
"schema" : {
- "minimum" : 1,
"type" : "integer"
}
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "content" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "description" : "snippet names cannot include '}' or start with spaces"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
+ }, {
+ "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 a valid JSON string.",
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31342,123 +39493,86 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/native-query-snippet/{id}",
- "tags" : [ "/api/native-query-snippet" ]
+ "summary" : "GET /api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}",
+ "tags" : [ "/api/preview_embed" ]
}
},
- "/api/notification/" : {
+ "/api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
"get" : {
- "description" : "List notifications.\n - `creator_id`: if provided returns only notifications created by this user\n - `recipient_id`: if provided returns only notification that has recipient_id as a recipient\n - `creator_or_recipient_id`: if provided returns only notification that has user_id as creator or recipient\n - `card_id`: if provided returns only notification that has card_id as payload",
+ "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
+ "operationId" : "get-api-preview_embed-tiles-dashboard-token-dashcard-dashcard-id-card-card-id-zoom-x-y",
"parameters" : [ {
+ "in" : "path",
+ "name" : "token",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
- "in" : "query",
- "name" : "creator_id",
- "required" : false,
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
}, {
"description" : "value must be an integer greater than zero.",
- "in" : "query",
- "name" : "recipient_id",
- "required" : false,
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
}, {
- "description" : "value must be an integer greater than zero.",
- "in" : "query",
- "name" : "creator_or_recipient_id",
- "required" : false,
+ "description" : "value must be an integer.",
+ "in" : "path",
+ "name" : "zoom",
+ "required" : true,
"schema" : {
- "minimum" : 1,
"type" : "integer"
}
}, {
- "description" : "value must be an integer greater than zero.",
- "in" : "query",
- "name" : "card_id",
- "required" : false,
+ "description" : "value must be an integer.",
+ "in" : "path",
+ "name" : "x",
+ "required" : true,
"schema" : {
- "minimum" : 1,
"type" : "integer"
}
}, {
- "in" : "query",
- "name" : "include_inactive",
- "required" : false,
+ "description" : "value must be an integer.",
+ "in" : "path",
+ "name" : "y",
+ "required" : true,
"schema" : {
- "type" : "boolean"
+ "type" : "integer"
}
}, {
+ "description" : "value must be a valid JSON string.",
"in" : "query",
- "name" : "payload_type",
+ "name" : "parameters",
"required" : false,
"schema" : {
- "oneOf" : [ {
- "enum" : [ "notification/dashboard", "notification/system-event", "notification/testing", "notification/card" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/notification/",
- "tags" : [ "/api/notification" ]
- },
- "post" : {
- "description" : "Create a new notification, return the created notification.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.notification.models.FullyHydratedNotification"
- }
- }
+ "type" : "string"
}
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
- },
- "summary" : "POST /api/notification/",
- "tags" : [ "/api/notification" ]
- }
- },
- "/api/notification/send" : {
- "post" : {
- "description" : "Send an unsaved notification.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.notification.models.FullyHydratedNotification"
- }
- }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
- },
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31470,74 +39584,42 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/notification/send",
- "tags" : [ "/api/notification" ]
+ "summary" : "GET /api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
+ "tags" : [ "/api/preview_embed" ]
}
},
- "/api/notification/unsubscribe/" : {
+ "/api/product-feedback" : {
"post" : {
- "description" : "Allow non-users to unsubscribe from notifications, with the hash given through email.",
+ "description" : "Endpoint to provide feedback from the product",
+ "operationId" : "post-api-product-feedback",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "email" : {
- "type" : "string"
- },
- "hash" : {
- "type" : "string"
+ "comments" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "notification-handler-id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "notification-handler-id", "email", "hash" ],
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/notification/unsubscribe/",
- "tags" : [ "/api/notification/unsubscribe" ]
- }
- },
- "/api/notification/unsubscribe/undo" : {
- "post" : {
- "description" : "Allow non-users to undo an unsubscribe from notifications, with the hash given through email.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
"email" : {
- "type" : "string"
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "hash" : {
+ "source" : {
+ "minLength" : 1,
"type" : "string"
- },
- "notification-handler-id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
}
},
- "required" : [ "notification-handler-id", "email", "hash" ],
+ "required" : [ "source" ],
"type" : "object"
}
}
@@ -31554,21 +39636,22 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/notification/unsubscribe/undo",
- "tags" : [ "/api/notification/unsubscribe" ]
+ "summary" : "POST /api/product-feedback",
+ "tags" : [ "/api/product-feedback" ]
}
},
- "/api/notification/{id}" : {
+ "/api/public/action/{uuid}" : {
"get" : {
- "description" : "Get a notification by id.",
+ "description" : "Fetch a publicly-accessible Action. Does not require auth credentials. Public sharing must be enabled.",
+ "operationId" : "get-api-public-action-uuid",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
}
} ],
"responses" : {
@@ -31582,26 +39665,39 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/notification/{id}",
- "tags" : [ "/api/notification" ]
- },
- "put" : {
- "description" : "Update a notification, can also update its subscriptions, handlers.\n Return the updated notification.",
+ "summary" : "GET /api/public/action/{uuid}",
+ "tags" : [ "/api/public" ]
+ }
+ },
+ "/api/public/action/{uuid}/execute" : {
+ "post" : {
+ "description" : "Execute the Action.\n\n `parameters` should be the mapped dashboard parameters with values.",
+ "operationId" : "post-api-public-action-uuid-execute",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.notification.models.FullyHydratedNotification"
+ "properties" : {
+ "parameters" : {
+ "oneOf" : [ {
+ "additionalProperties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
}
}
}
@@ -31617,42 +39713,24 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/notification/{id}",
- "tags" : [ "/api/notification" ]
+ "summary" : "POST /api/public/action/{uuid}/execute",
+ "tags" : [ "/api/public" ]
}
},
- "/api/notification/{id}/send" : {
- "post" : {
- "description" : "Send a notification by id.",
+ "/api/public/card/{uuid}" : {
+ "get" : {
+ "description" : "Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth\n credentials. Public sharing must be enabled.",
+ "operationId" : "get-api-public-card-uuid",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "handler_ids" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
- }
- },
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31664,22 +39742,36 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/notification/{id}/send",
- "tags" : [ "/api/notification" ]
+ "summary" : "GET /api/public/card/{uuid}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/notification/{id}/unsubscribe" : {
- "post" : {
- "description" : "Unsubscribe current user from a notification.",
+ "/api/public/card/{uuid}/params/{param-key}/remapping" : {
+ "get" : {
+ "description" : "Fetch the remapped value for the given `value` of parameter with ID `:param-key` of card with UUID `uuid`.",
+ "operationId" : "get-api-public-card-uuid-params-param-key-remapping",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
}
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : { }
} ],
"responses" : {
"2XX" : {
@@ -31692,49 +39784,40 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/notification/{id}/unsubscribe",
- "tags" : [ "/api/notification" ]
+ "summary" : "GET /api/public/card/{uuid}/params/{param-key}/remapping",
+ "tags" : [ "/api/public" ]
}
},
- "/api/notify/db/attached_datawarehouse" : {
- "post" : {
- "description" : "Sync the attached datawarehouse. Can provide in the body:\n - table_name and schema_name: both strings. Will look for an existing table and sync it, otherwise will try to find a\n new table with that name and sync it. If it cannot find a table it will throw an error. If table_name is empty or\n blank, will sync the entire database.\n - synchronous?: is a boolean value to indicate if this should block on the result.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "schema_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "synchronous?" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "table_name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "synchronous?" ],
- "type" : "object"
- }
- }
+ "/api/public/card/{uuid}/params/{param-key}/search/{query}" : {
+ "get" : {
+ "description" : "Fetch values for a parameter on a public card containing `query`.",
+ "operationId" : "get-api-public-card-uuid-params-param-key-search-query",
+ "parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
}
- },
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "query",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31746,59 +39829,32 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/notify/db/attached_datawarehouse",
- "tags" : [ "/api/notify" ]
+ "summary" : "GET /api/public/card/{uuid}/params/{param-key}/search/{query}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/notify/db/{id}" : {
- "post" : {
- "description" : "Notification about a potential schema change to one of our `Databases`.\n Caller can optionally specify a `:table_id` or `:table_name` in the body to limit updates to a single\n `Table`. Optional Parameter `:scan` can be `\"full\"` or `\"schema\"` for a full sync or a schema sync, available\n regardless if a `:table_id` or `:table_name` is passed.\n This endpoint is secured by an API key that needs to be passed as a `X-METABASE-APIKEY` header which needs to be defined in\n the `MB_API_KEY` [environment variable](https://www.metabase.com/docs/latest/configuring-metabase/environment-variables.html#mb_api_key)",
+ "/api/public/card/{uuid}/params/{param-key}/values" : {
+ "get" : {
+ "description" : "Fetch values for a parameter on a public card.",
+ "operationId" : "get-api-public-card-uuid-params-param-key-values",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
}
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "scan" : {
- "oneOf" : [ {
- "enum" : [ "full", "schema" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "table_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "table_name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
}
- },
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31810,43 +39866,36 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/notify/db/{id}",
- "tags" : [ "/api/notify" ]
+ "summary" : "GET /api/public/card/{uuid}/params/{param-key}/values",
+ "tags" : [ "/api/public" ]
}
},
- "/api/notify/db/{id}/new-table" : {
- "post" : {
- "description" : "Sync a new table without running a full database sync. Requires `schema_name` and `table_name`. Will throw an error\n if the table already exists in Metabase or cannot be found.",
+ "/api/public/card/{uuid}/query" : {
+ "get" : {
+ "description" : "Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth\n credentials. Public sharing must be enabled.",
+ "operationId" : "get-api-public-card-uuid-query",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
}
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "schema_name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "table_name" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "schema_name", "table_name" ],
- "type" : "object"
- }
- }
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid JSON string.",
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
- },
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31858,65 +39907,59 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/notify/db/{id}/new-table",
- "tags" : [ "/api/notify" ]
+ "summary" : "GET /api/public/card/{uuid}/query",
+ "tags" : [ "/api/public" ]
}
},
- "/api/permissions/graph" : {
+ "/api/public/card/{uuid}/query/{export-format}" : {
"get" : {
- "description" : "Fetch a graph of all Permissions.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "description" : "Fetch a publicly-accessible Card and return query results in the specified format. Does not require auth\n credentials. Public sharing must be enabled.",
+ "operationId" : "get-api-public-card-uuid-query-export-format",
+ "parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
}
- },
- "summary" : "GET /api/permissions/graph",
- "tags" : [ "/api/permissions" ]
- },
- "put" : {
- "description" : "Do a batch update of Permissions by passing in a modified graph. This should return the same graph, in the same\n format, that you got from `GET /api/permissions/graph`, with any changes made in the wherever necessary. This\n modified graph must correspond to the `PermissionsGraph` schema. If successful, this endpoint returns the updated\n permissions graph; use this as a base for any further modifications.\n\n Revisions to the permissions graph are tracked. If you fetch the permissions graph and some other third-party\n modifies it before you can submit you revisions, the endpoint will instead make no changes and return a\n 409 (Conflict) response. In this case, you should fetch the updated graph and make desired changes to that.\n\n The optional `sandboxes` key contains a list of sandboxes that should be created or modified in conjunction with\n this permissions graph update. Since data sandboxing is an Enterprise Edition-only feature, a 402 (Payment Required)\n response will be returned if this key is present and the server is not running the Enterprise Edition, and/or the\n `:sandboxes` feature flag is not present.\n\n If the skip-graph query param is truthy, then the graph will not be returned.",
- "parameters" : [ {
+ }, {
"in" : "query",
- "name" : "skip-graph",
+ "name" : "format_rows",
"required" : true,
"schema" : {
"default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "type" : "boolean"
}
}, {
"in" : "query",
- "name" : "force",
+ "name" : "pivot_results",
"required" : true,
"schema" : {
"default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be a valid JSON string.",
+ "type" : "string"
}, {
"type" : "null"
} ]
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : { },
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -31928,21 +39971,22 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/permissions/graph",
- "tags" : [ "/api/permissions" ]
+ "summary" : "GET /api/public/card/{uuid}/query/{export-format}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/permissions/graph/db/{db-id}" : {
+ "/api/public/dashboard/{uuid}" : {
"get" : {
- "description" : "Fetch a graph of all Permissions for db-id `db-id`.",
+ "description" : "Fetch a publicly-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled.",
+ "operationId" : "get-api-public-dashboard-uuid",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "db-id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
}
} ],
"responses" : {
@@ -31956,22 +40000,53 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/permissions/graph/db/{db-id}",
- "tags" : [ "/api/permissions" ]
+ "summary" : "GET /api/public/dashboard/{uuid}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/permissions/graph/group/{group-id}" : {
+ "/api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}" : {
"get" : {
- "description" : "Fetch a graph of all Permissions for group-id `group-id`.",
+ "description" : "Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Public\n sharing must be enabled.",
+ "operationId" : "get-api-public-dashboard-uuid-dashcard-dashcard-id-card-card-id",
"parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "group-id",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid JSON string.",
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -31984,57 +40059,75 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/permissions/graph/group/{group-id}",
- "tags" : [ "/api/permissions" ]
+ "summary" : "GET /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/permissions/group" : {
- "get" : {
- "description" : "Fetch all `PermissionsGroups`, including a count of the number of `:members` in that group.\n This API requires superuser or group manager of more than one group.\n Group manager is only available if `advanced-permissions` is enabled and returns only groups that user\n is manager of.\n\n Optional query parameter `tenancy` can be used to filter groups:\n - `tenancy=external`: Returns only tenant groups (where `is_tenant_group = true`)\n - `tenancy=internal`: Returns only non-tenant groups (where `is_tenant_group = false`)\n - No `tenancy` parameter: Returns all groups (default behavior)",
+ "/api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
+ "post" : {
+ "description" : "Fetch the results of running a publicly-accessible Card belonging to a Dashboard and return the data in one of the\n export formats. Does not require auth credentials. Public sharing must be enabled.",
+ "operationId" : "post-api-public-dashboard-uuid-dashcard-dashcard-id-card-card-id-export-format",
"parameters" : [ {
- "in" : "query",
- "name" : "tenancy",
- "required" : false,
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
"schema" : {
- "enum" : [ "external", "internal" ],
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"type" : "string"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
- "summary" : "GET /api/permissions/group",
- "tags" : [ "/api/permissions" ]
- },
- "post" : {
- "description" : "Create a new `PermissionsGroup`.",
- "parameters" : [ ],
+ }, {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "is_tenant_group" : {
+ "format_rows" : {
+ "default" : false,
+ "type" : "boolean"
+ },
+ "parameters" : {
"oneOf" : [ {
- "type" : "boolean"
+ "items" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
},
- "name" : {
- "minLength" : 1,
- "type" : "string"
+ "pivot_results" : {
+ "default" : false,
+ "type" : "boolean"
}
},
- "required" : [ "name" ],
+ "required" : [ "format_rows", "pivot_results" ],
"type" : "object"
}
}
@@ -32051,22 +40144,40 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/permissions/group",
- "tags" : [ "/api/permissions" ]
+ "summary" : "POST /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/permissions/group/{group-id}" : {
- "delete" : {
- "description" : "Delete a specific `PermissionsGroup`.",
+ "/api/public/dashboard/{uuid}/dashcard/{dashcard-id}/execute" : {
+ "get" : {
+ "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",
+ "operationId" : "get-api-public-dashboard-uuid-dashcard-dashcard-id-execute",
"parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "group-id",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "description" : "value must be a valid JSON string.",
+ "in" : "query",
+ "name" : "parameters",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -32079,15 +40190,25 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/permissions/group/{group-id}",
- "tags" : [ "/api/permissions" ]
+ "summary" : "GET /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/execute",
+ "tags" : [ "/api/public" ]
},
- "put" : {
- "description" : "Update the name of a `PermissionsGroup`.",
+ "post" : {
+ "description" : "Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.\n\n `parameters` should be the mapped dashboard parameters with values.",
+ "operationId" : "post-api-public-dashboard-uuid-dashcard-dashcard-id-execute",
"parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "group-id",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -32099,12 +40220,15 @@
"application/json" : {
"schema" : {
"properties" : {
- "name" : {
- "minLength" : 1,
- "type" : "string"
+ "parameters" : {
+ "oneOf" : [ {
+ "additionalProperties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "name" ],
"type" : "object"
}
}
@@ -32121,22 +40245,36 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/permissions/group/{group-id}",
- "tags" : [ "/api/permissions" ]
+ "summary" : "POST /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/execute",
+ "tags" : [ "/api/public" ]
}
},
- "/api/permissions/group/{id}" : {
+ "/api/public/dashboard/{uuid}/params/{param-key}/remapping" : {
"get" : {
- "description" : "Fetch the details for a certain permissions group.",
+ "description" : "Fetch the remapped value for the given `value` of parameter with ID `:param-key` of dashboard with UUID `uuid`.",
+ "operationId" : "get-api-public-dashboard-uuid-params-param-key-remapping",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
}
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : { }
} ],
"responses" : {
"2XX" : {
@@ -32149,14 +40287,40 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/permissions/group/{id}",
- "tags" : [ "/api/permissions" ]
+ "summary" : "GET /api/public/dashboard/{uuid}/params/{param-key}/remapping",
+ "tags" : [ "/api/public" ]
}
},
- "/api/permissions/membership" : {
+ "/api/public/dashboard/{uuid}/params/{param-key}/search/{query}" : {
"get" : {
- "description" : "Fetch a map describing the group memberships of various users.\n This map's format is:\n\n {<user-id> [{:membership_id <id>\n :group_id <id>\n :is_group_manager boolean}]}",
- "parameters" : [ ],
+ "description" : "Fetch filter values for dashboard parameter `param-key`, containing specified `query`.",
+ "operationId" : "get-api-public-dashboard-uuid-params-param-key-search-query",
+ "parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "query",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -32168,42 +40332,32 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/permissions/membership",
- "tags" : [ "/api/permissions" ]
- },
- "post" : {
- "description" : "Add a `User` to a `PermissionsGroup`. Returns updated list of members belonging to the group.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "group_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "is_group_manager" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "user_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "group_id", "user_id", "is_group_manager" ],
- "type" : "object"
- }
- }
+ "summary" : "GET /api/public/dashboard/{uuid}/params/{param-key}/search/{query}",
+ "tags" : [ "/api/public" ]
+ }
+ },
+ "/api/public/dashboard/{uuid}/params/{param-key}/values" : {
+ "get" : {
+ "description" : "Fetch filter values for dashboard parameter `param-key`.",
+ "operationId" : "get-api-public-dashboard-uuid-params-param-key-values",
+ "parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
}
- },
+ }, {
+ "in" : "path",
+ "name" : "param-key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -32215,21 +40369,22 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/permissions/membership",
- "tags" : [ "/api/permissions" ]
+ "summary" : "GET /api/public/dashboard/{uuid}/params/{param-key}/values",
+ "tags" : [ "/api/public" ]
}
},
- "/api/permissions/membership/{group-id}/clear" : {
- "put" : {
- "description" : "Remove all members from a `PermissionsGroup`. Returns a 400 (Bad Request) if the group ID is for the admin group.",
+ "/api/public/document/{uuid}" : {
+ "get" : {
+ "description" : "Fetch a publicly-accessible Document. Does not require auth credentials. Public sharing must be enabled.\n\n Returns a Document with sensitive fields removed (excludes collection_id, permissions, creator details, etc.).\n Includes all embedded Cards with their metadata hydrated so the frontend doesn't need to make separate\n requests for each card — just like public Dashboards do.",
+ "operationId" : "get-api-public-document-uuid",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "group-id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
}
} ],
"responses" : {
@@ -32243,22 +40398,44 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/permissions/membership/{group-id}/clear",
- "tags" : [ "/api/permissions" ]
+ "summary" : "GET /api/public/document/{uuid}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/permissions/membership/{id}" : {
- "delete" : {
- "description" : "Remove a User from a PermissionsGroup (delete their membership).",
+ "/api/public/document/{uuid}/card/{card-id}" : {
+ "get" : {
+ "description" : "Run a query for a Card that's embedded in a public Document. Doesn't require auth credentials. Public sharing must\n be enabled.",
+ "operationId" : "get-api-public-document-uuid-card-card-id",
"parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid JSON string.",
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -32271,31 +40448,72 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/permissions/membership/{id}",
- "tags" : [ "/api/permissions" ]
- },
- "put" : {
- "description" : "Update a Permission Group membership. Returns the updated record.",
+ "summary" : "GET /api/public/document/{uuid}/card/{card-id}",
+ "tags" : [ "/api/public" ]
+ }
+ },
+ "/api/public/document/{uuid}/card/{card-id}/{export-format}" : {
+ "post" : {
+ "description" : "Fetch a Card embedded in a public Document and return query results in the specified format.\n Does not require auth credentials. Public sharing must be enabled.",
+ "operationId" : "post-api-public-document-uuid-card-card-id-export-format",
"parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "path",
+ "name" : "export-format",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
+ }
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "is_group_manager" : {
+ "format_rows" : {
+ "default" : false,
+ "type" : "boolean"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "items" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "description" : "value must be a valid JSON string.",
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "pivot_results" : {
+ "default" : false,
"type" : "boolean"
}
},
- "required" : [ "is_group_manager" ],
+ "required" : [ "format_rows", "pivot_results" ],
"type" : "object"
}
}
@@ -32312,14 +40530,54 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/permissions/membership/{id}",
- "tags" : [ "/api/permissions" ]
+ "summary" : "POST /api/public/document/{uuid}/card/{card-id}/{export-format}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/persist/" : {
+ "/api/public/oembed" : {
"get" : {
- "description" : "List the entries of [[PersistedInfo]] in order to show a status page.",
- "parameters" : [ ],
+ "description" : "oEmbed endpoint used to retrieve embed code and metadata for a (public) Metabase URL.",
+ "operationId" : "get-api-public-oembed",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "url",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "description" : "The format param is not used by the API, but is required as part of the oEmbed spec: http://oembed.com/#section2 just return an error if `format` is specified and it's anything other than `json`.",
+ "in" : "query",
+ "name" : "format",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "enum" : [ "json" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "maxheight",
+ "required" : true,
+ "schema" : {
+ "default" : 800,
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "maxwidth",
+ "required" : true,
+ "schema" : {
+ "default" : 1024,
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -32331,21 +40589,34 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/persist/",
- "tags" : [ "/api/persist" ]
+ "summary" : "GET /api/public/oembed",
+ "tags" : [ "/api/public" ]
}
},
- "/api/persist/card/{card-id}" : {
+ "/api/public/pivot/card/{uuid}/query" : {
"get" : {
- "description" : "Fetch a particular [[PersistedInfo]] by card-id.",
+ "description" : "Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth\n credentials. Public sharing must be enabled.",
+ "operationId" : "get-api-public-pivot-card-uuid-query",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "card-id",
+ "name" : "uuid",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid JSON string.",
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
@@ -32359,14 +40630,24 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/persist/card/{card-id}",
- "tags" : [ "/api/persist" ]
+ "summary" : "GET /api/public/pivot/card/{uuid}/query",
+ "tags" : [ "/api/public" ]
}
},
- "/api/persist/card/{card-id}/persist" : {
- "post" : {
- "description" : "Mark the model (card) as persisted. Runs the query and saves it to the database backing the card and hot swaps this\n query in place of the model's query.",
+ "/api/public/pivot/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "get" : {
+ "description" : "Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Public\n sharing must be enabled.",
+ "operationId" : "get-api-public-pivot-dashboard-uuid-dashcard-dashcard-id-card-card-id",
"parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
"name" : "card-id",
@@ -32375,34 +40656,27 @@
"minimum" : 1,
"type" : "integer"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/persist/card/{card-id}/persist",
- "tags" : [ "/api/persist" ]
- }
- },
- "/api/persist/card/{card-id}/refresh" : {
- "post" : {
- "description" : "Refresh the persisted model caching `card-id`.",
- "parameters" : [ {
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "card-id",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid JSON string.",
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
@@ -32415,22 +40689,69 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/persist/card/{card-id}/refresh",
- "tags" : [ "/api/persist" ]
+ "summary" : "GET /api/public/pivot/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/persist/card/{card-id}/unpersist" : {
- "post" : {
- "description" : "Unpersist this model. Deletes the persisted table backing the model and all queries after this will use the card's\n query rather than the saved version of the query.",
+ "/api/public/tiles/card/{uuid}/{zoom}/{x}/{y}" : {
+ "get" : {
+ "description" : "Generates a single tile image for a publicly-accessible Card using the map visualization. Does not require auth\n credentials. Public sharing must be enabled.",
+ "operationId" : "get-api-public-tiles-card-uuid-zoom-x-y",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
+ "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "card-id",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
+ "description" : "value must be an integer.",
+ "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" : {
- "minimum" : 1,
"type" : "integer"
}
+ }, {
+ "description" : "value must be a valid JSON string.",
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -32443,50 +40764,87 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/persist/card/{card-id}/unpersist",
- "tags" : [ "/api/persist" ]
+ "summary" : "GET /api/public/tiles/card/{uuid}/{zoom}/{x}/{y}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/persist/database/{id}/persist" : {
- "post" : {
- "description" : "Attempt to enable model persistence for a database. If already enabled returns a generic 204.",
+ "/api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
+ "get" : {
+ "description" : "Generates a single tile image for a Card using the map visualization in a publicly-accessible Dashboard. Does not\n require auth credentials. Public sharing must be enabled.",
+ "operationId" : "get-api-public-tiles-dashboard-uuid-dashcard-dashcard-id-card-card-id-zoom-x-y",
"parameters" : [ {
+ "description" : "value must be a valid UUID.",
+ "in" : "path",
+ "name" : "uuid",
+ "required" : true,
+ "schema" : {
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "type" : "string"
+ }
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "dashcard-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/persist/database/{id}/persist",
- "tags" : [ "/api/persist" ]
- }
- },
- "/api/persist/database/{id}/unpersist" : {
- "post" : {
- "description" : "Attempt to disable model persistence for a database. If already not enabled, just returns a generic 204.",
- "parameters" : [ {
+ }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "card-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "description" : "value must be an integer.",
+ "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 a valid JSON string.",
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"2XX" : {
@@ -32499,33 +40857,52 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/persist/database/{id}/unpersist",
- "tags" : [ "/api/persist" ]
+ "summary" : "GET /api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
+ "tags" : [ "/api/public" ]
}
},
- "/api/persist/disable" : {
- "post" : {
- "description" : "Disable global setting to allow databases to persist models. This will remove all tasks to refresh tables, remove\n that option from databases which might have it enabled, and delete all cached tables.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "/api/pulse" : {
+ "get" : {
+ "description" : "Fetch all dashboard subscriptions. By default, returns only subscriptions for which the current user has write\n permissions. For admins, this is all subscriptions; for non-admins, it is only subscriptions that they created.\n\n If `dashboard_id` is specified, restricts results to subscriptions for that dashboard.\n\n If `created_or_receive` is `true`, it specifically returns all subscriptions for which the current user\n created *or* is a known recipient of. Note that this is a superset of the default items returned for non-admins,\n and a subset of the default items returned for admins. This is used to power the /account/notifications page.\n This may include subscriptions which the current user does not have collection permissions for, in which case\n some sensitive metadata (the list of cards and recipients) is stripped out.",
+ "operationId" : "get-api-pulse",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "archived",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "summary" : "POST /api/persist/disable",
- "tags" : [ "/api/persist" ]
- }
- },
- "/api/persist/enable" : {
- "post" : {
- "description" : "Enable global setting to allow databases to persist models.",
- "parameters" : [ ],
+ }, {
+ "in" : "query",
+ "name" : "dashboard_id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "creator_or_recipient",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -32537,26 +40914,72 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/persist/enable",
- "tags" : [ "/api/persist" ]
- }
- },
- "/api/persist/set-refresh-schedule" : {
+ "summary" : "GET /api/pulse",
+ "tags" : [ "/api/pulse" ]
+ },
"post" : {
- "description" : "Set the cron schedule to refresh persisted models.\n Shape should be JSON like {cron: \"0 30 1/8 * * ? *\"}.",
+ "description" : "Create a new `Pulse`.",
+ "operationId" : "post-api-pulse",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "cron" : {
- "description" : "Value must be a string representing a cron schedule of format <seconds> <minutes> <hours> <day of month> <month> <day of week> <year>",
+ "cards" : { },
+ "channels" : { },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
"minLength" : 1,
"type" : "string"
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "items" : {
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "skip_if_empty" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "cron" ],
+ "required" : [ "name", "cards", "channels", "skip_if_empty" ],
"type" : "object"
}
}
@@ -32573,41 +40996,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/persist/set-refresh-schedule",
- "tags" : [ "/api/persist" ]
- }
- },
- "/api/persist/{persisted-info-id}" : {
- "get" : {
- "description" : "Fetch a particular [[PersistedInfo]] by id.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "persisted-info-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/persist/{persisted-info-id}",
- "tags" : [ "/api/persist" ]
+ "summary" : "POST /api/pulse",
+ "tags" : [ "/api/pulse" ]
}
},
- "/api/premium-features/token/status" : {
+ "/api/pulse/form_input" : {
"get" : {
- "description" : "Fetch info about the current Premium-Features premium features token including whether it is `valid`, a `trial` token, its\n `features`, when it is `valid-thru`, and the `status` of the account.",
+ "description" : "Provides relevant configuration information and user choices for creating/updating Pulses.",
+ "operationId" : "get-api-pulse-form_input",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -32620,62 +41016,76 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/premium-features/token/status",
- "tags" : [ "/api/premium-features" ]
- }
- },
- "/api/preview_embed/card/{token}" : {
- "get" : {
- "description" : "Fetch a Card you're considering embedding by passing a JWT `token`.",
- "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"
- }
- },
- "summary" : "GET /api/preview_embed/card/{token}",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "GET /api/pulse/form_input",
+ "tags" : [ "/api/pulse" ]
}
},
- "/api/preview_embed/card/{token}/params/{param-key}/remapping" : {
- "get" : {
- "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" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "/api/pulse/test" : {
+ "post" : {
+ "description" : "Test send an unsaved pulse.",
+ "operationId" : "post-api-pulse-test",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "cards" : { },
+ "channels" : { },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_position" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dashboard_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "disable_links" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "skip_if_empty" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "name", "cards", "channels", "skip_if_empty", "disable_links" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -32687,81 +41097,38 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/card/{token}/params/{param-key}/remapping",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "POST /api/pulse/test",
+ "tags" : [ "/api/pulse" ]
}
},
- "/api/preview_embed/card/{token}/params/{param-key}/values" : {
- "get" : {
- "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"
- }
- } ],
- "responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "has_more_values" : {
- "type" : "boolean"
- },
- "values" : {
- "items" : {
- "anyOf" : [ {
- "prefixItems" : [ { }, {
- "type" : "string"
- } ],
- "type" : "array"
- }, {
- "prefixItems" : [ { } ],
- "type" : "array"
- } ]
- },
- "type" : "array"
- }
+ "/api/pulse/unsubscribe" : {
+ "post" : {
+ "description" : "Allow non-users to unsubscribe from pulses/subscriptions, with the hash given through email.",
+ "operationId" : "post-api-pulse-unsubscribe",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "email" : {
+ "type" : "string"
},
- "required" : [ "has_more_values", "values" ],
- "type" : "object"
- }
+ "hash" : {
+ "type" : "string"
+ },
+ "pulse-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "pulse-id", "email", "hash" ],
+ "type" : "object"
}
- },
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ }
}
},
- "summary" : "GET /api/preview_embed/card/{token}/params/{param-key}/values",
- "tags" : [ "/api/preview_embed" ]
- }
- },
- "/api/preview_embed/card/{token}/query" : {
- "get" : {
- "description" : "Fetch the query results for a Card you're considering embedding by passing a JWT `token`.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -32773,21 +41140,38 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/card/{token}/query",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "POST /api/pulse/unsubscribe",
+ "tags" : [ "/api/pulse/unsubscribe" ]
}
},
- "/api/preview_embed/dashboard/{token}" : {
- "get" : {
- "description" : "Fetch a Dashboard you're considering embedding by passing a JWT `token`. ",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "/api/pulse/unsubscribe/undo" : {
+ "post" : {
+ "description" : "Allow non-users to undo an unsubscribe from pulses/subscriptions, with the hash given through email.",
+ "operationId" : "post-api-pulse-unsubscribe-undo",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "email" : {
+ "type" : "string"
+ },
+ "hash" : {
+ "type" : "string"
+ },
+ "pulse-id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "pulse-id", "email", "hash" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -32799,33 +41183,18 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/dashboard/{token}",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "POST /api/pulse/unsubscribe/undo",
+ "tags" : [ "/api/pulse/unsubscribe" ]
}
},
- "/api/preview_embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "/api/pulse/{id}" : {
"get" : {
- "description" : "Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT `token`.",
+ "description" : "Fetch `Pulse` with ID. If the user is a recipient of the Pulse but does not have read permissions for its collection,\n we still return it but with some sensitive metadata removed.",
+ "operationId" : "get-api-pulse-id",
"parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -32843,29 +41212,89 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "tags" : [ "/api/preview_embed" ]
- }
- },
- "/api/preview_embed/dashboard/{token}/params/{param-key}/remapping" : {
- "get" : {
- "description" : "Embedded version of the remapped dashboard param value endpoint.",
+ "summary" : "GET /api/pulse/{id}",
+ "tags" : [ "/api/pulse" ]
+ },
+ "put" : {
+ "description" : "Update a Pulse with `id`.",
+ "operationId" : "put-api-pulse-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "archived" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "cards" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "channels" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "parameters" : {
+ "oneOf" : [ {
+ "items" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "skip_if_empty" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "skip_if_empty", "archived" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -32877,35 +41306,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/remapping",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "PUT /api/pulse/{id}",
+ "tags" : [ "/api/pulse" ]
}
},
- "/api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
- "get" : {
- "description" : "Embedded version of chain filter search endpoint.",
+ "/api/pulse/{id}/subscription" : {
+ "delete" : {
+ "description" : "For users to unsubscribe themselves from a pulse subscription.",
+ "operationId" : "delete-api-pulse-id-subscription",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "prefix",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -32919,26 +41335,29 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "DELETE /api/pulse/{id}/subscription",
+ "tags" : [ "/api/pulse" ]
}
},
- "/api/preview_embed/dashboard/{token}/params/{param-key}/values" : {
+ "/api/revision" : {
"get" : {
- "description" : "Embedded version of chain filter values endpoint.",
+ "description" : "Get revisions of an object.",
+ "operationId" : "get-api-revision",
"parameters" : [ {
- "in" : "path",
- "name" : "token",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "query",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
- "in" : "path",
- "name" : "param-key",
+ "in" : "query",
+ "name" : "entity",
"required" : true,
"schema" : {
- "minLength" : 1,
+ "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ],
"type" : "string"
}
} ],
@@ -32953,21 +41372,41 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/values",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "GET /api/revision",
+ "tags" : [ "/api/revision" ]
}
},
- "/api/preview_embed/pivot/card/{token}/query" : {
- "get" : {
- "description" : "Fetch the query results for a Card you're considering embedding by passing a JWT `token`.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "/api/revision/revert" : {
+ "post" : {
+ "description" : "Revert an object to a prior revision.",
+ "operationId" : "post-api-revision-revert",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "entity" : {
+ "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ],
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "revision_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "id", "entity", "revision_id" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -32979,33 +41418,26 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/pivot/card/{token}/query",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "POST /api/revision/revert",
+ "tags" : [ "/api/revision" ]
}
},
- "/api/preview_embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}" : {
+ "/api/revision/{entity}/{id}" : {
"get" : {
- "description" : "Fetch the results of running a Card belonging to a Dashboard you're considering embedding with JWT `token`.",
+ "description" : "Fetch `Revisions` for an object with ID.",
+ "operationId" : "get-api-revision-entity-id",
"parameters" : [ {
"in" : "path",
- "name" : "token",
+ "name" : "entity",
"required" : true,
"schema" : {
+ "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ],
"type" : "string"
}
}, {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
+ "name" : "id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -33023,155 +41455,290 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/pivot/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "GET /api/revision/{entity}/{id}",
+ "tags" : [ "/api/revision" ]
}
},
- "/api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}" : {
+ "/api/search" : {
"get" : {
- "description" : "Generates a single tile image for an embedded Card using the map visualization.",
+ "description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filters_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n - `non_temporal_dim_ids`: search for cards/metrics/datasets with this exact set of non temporal dimension field IDs (requires appdb engine)\n - `has_temporal_dim`: set to true for cards/metrics/datasets with 1 or more temporal dimensions (requires appdb engine)\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",
+ "operationId" : "get-api-search",
"parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
+ "in" : "query",
+ "name" : "q",
+ "required" : false,
"schema" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "zoom",
- "required" : true,
+ "in" : "query",
+ "name" : "context",
+ "required" : false,
"schema" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "x",
+ "in" : "query",
+ "name" : "archived",
"required" : true,
"schema" : {
- "type" : "integer"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "y",
- "required" : true,
+ "in" : "query",
+ "name" : "collection",
+ "required" : false,
"schema" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "table_db_id",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "models",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "items" : {
+ "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "filter_items_in_personal_collection",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "enum" : [ "all", "only", "only-mine", "exclude", "exclude-others" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "created_at",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "created_by",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "display_type",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "items" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be a valid JSON string.",
"in" : "query",
- "name" : "parameters",
+ "name" : "last_edited_at",
"required" : false,
"schema" : {
- "type" : "string"
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "latField",
- "required" : true,
+ "name" : "last_edited_by",
+ "required" : false,
"schema" : {
- "type" : "string"
+ "oneOf" : [ {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "lonField",
+ "name" : "model_ancestors",
"required" : true,
"schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "summary" : "GET /api/preview_embed/tiles/card/{token}/{zoom}/{x}/{y}",
- "tags" : [ "/api/preview_embed" ]
- }
- },
- "/api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
- "get" : {
- "description" : "Generates a single tile image for a Card on an embedded Dashboard using the map visualization.",
- "parameters" : [ {
- "in" : "path",
- "name" : "token",
- "required" : true,
+ }, {
+ "in" : "query",
+ "name" : "search_engine",
+ "required" : false,
"schema" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
+ "in" : "query",
+ "name" : "search_native_query",
+ "required" : false,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
+ "in" : "query",
+ "name" : "verified",
+ "required" : false,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "zoom",
- "required" : true,
+ "in" : "query",
+ "name" : "ids",
+ "required" : false,
"schema" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "x",
- "required" : true,
+ "in" : "query",
+ "name" : "calculate_available_models",
+ "required" : false,
"schema" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "y",
+ "in" : "query",
+ "name" : "include_dashboard_questions",
"required" : true,
"schema" : {
- "type" : "integer"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be a valid JSON string.",
"in" : "query",
- "name" : "parameters",
- "required" : false,
+ "name" : "include_metadata",
+ "required" : true,
"schema" : {
- "type" : "string"
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "latField",
- "required" : true,
+ "name" : "non_temporal_dim_ids",
+ "required" : false,
"schema" : {
- "type" : "string"
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "lonField",
- "required" : true,
+ "name" : "has_temporal_dim",
+ "required" : false,
"schema" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
@@ -33185,46 +41752,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/preview_embed/tiles/dashboard/{token}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
- "tags" : [ "/api/preview_embed" ]
+ "summary" : "GET /api/search",
+ "tags" : [ "/api/search" ]
}
},
- "/api/product-feedback/" : {
+ "/api/search/force-reindex" : {
"post" : {
- "description" : "Endpoint to provide feedback from the product",
+ "description" : "This will trigger an immediate reindexing, if we are using search index.",
+ "operationId" : "post-api-search-force-reindex",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "comments" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "email" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "source" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "source" ],
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33236,23 +41772,15 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/product-feedback/",
- "tags" : [ "/api/product-feedback" ]
+ "summary" : "POST /api/search/force-reindex",
+ "tags" : [ "/api/search" ]
}
},
- "/api/public/action/{uuid}" : {
- "get" : {
- "description" : "Fetch a publicly-accessible Action. Does not require auth credentials. Public sharing must be enabled.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- } ],
+ "/api/search/re-init" : {
+ "post" : {
+ "description" : "This will blow away any search indexes, re-create, and re-populate them.",
+ "operationId" : "post-api-search-re-init",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33264,42 +41792,23 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/action/{uuid}",
- "tags" : [ "/api/public" ]
+ "summary" : "POST /api/search/re-init",
+ "tags" : [ "/api/search" ]
}
},
- "/api/public/action/{uuid}/execute" : {
- "post" : {
- "description" : "Execute the Action.\n\n `parameters` should be the mapped dashboard parameters with values.",
+ "/api/search/weights" : {
+ "get" : {
+ "description" : "Return the current weights being used to rank the search results",
+ "operationId" : "get-api-search-weights",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
+ "in" : "query",
+ "name" : "context",
"required" : true,
"schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "default" : "default",
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "parameters" : {
- "oneOf" : [ {
- "additionalProperties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33311,22 +41820,25 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/public/action/{uuid}/execute",
- "tags" : [ "/api/public" ]
- }
- },
- "/api/public/card/{uuid}" : {
- "get" : {
- "description" : "Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth\n credentials. Public sharing must be enabled.",
+ "summary" : "GET /api/search/weights",
+ "tags" : [ "/api/search" ]
+ },
+ "put" : {
+ "description" : "Update the current weights being used to rank the search results",
+ "operationId" : "put-api-search-weights",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
+ "in" : "query",
+ "name" : "context",
"required" : true,
"schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
+ "default" : "default",
"type" : "string"
}
+ }, {
+ "in" : "query",
+ "name" : "search_engine",
+ "required" : false,
+ "schema" : { }
} ],
"responses" : {
"2XX" : {
@@ -33339,36 +41851,66 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/card/{uuid}",
- "tags" : [ "/api/public" ]
+ "summary" : "PUT /api/search/weights",
+ "tags" : [ "/api/search" ]
}
},
- "/api/public/card/{uuid}/params/{param-key}/remapping" : {
+ "/api/segment" : {
"get" : {
- "description" : "Fetch the remapped value for the given `value` of parameter with ID `:param-key` of card with UUID `uuid`.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
+ "description" : "Fetch *all* `Segments`.",
+ "operationId" : "get-api-segment",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
+ },
+ "summary" : "GET /api/segment",
+ "tags" : [ "/api/segment" ]
+ },
+ "post" : {
+ "description" : "Create a new `Segment`.",
+ "operationId" : "post-api-segment",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "definition" : {
+ "description" : "Value must be a map.",
+ "properties" : { },
+ "type" : "object"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "table_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ },
+ "required" : [ "name", "table_id", "definition" ],
+ "type" : "object"
+ }
+ }
}
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : { }
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33380,33 +41922,26 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/card/{uuid}/params/{param-key}/remapping",
- "tags" : [ "/api/public" ]
+ "summary" : "POST /api/segment",
+ "tags" : [ "/api/segment" ]
}
},
- "/api/public/card/{uuid}/params/{param-key}/search/{query}" : {
- "get" : {
- "description" : "Fetch values for a parameter on a public card containing `query`.",
+ "/api/segment/{id}" : {
+ "delete" : {
+ "description" : "Archive a Segment. (DEPRECATED -- Just pass updated value of `:archived` to the `PUT` endpoint instead.)",
+ "operationId" : "delete-api-segment-id",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "param-key",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
- "in" : "path",
- "name" : "query",
+ "in" : "query",
+ "name" : "revision_message",
"required" : true,
"schema" : {
"minLength" : 1,
@@ -33424,29 +41959,20 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/card/{uuid}/params/{param-key}/search/{query}",
- "tags" : [ "/api/public" ]
- }
- },
- "/api/public/card/{uuid}/params/{param-key}/values" : {
+ "summary" : "DELETE /api/segment/{id}",
+ "tags" : [ "/api/segment" ]
+ },
"get" : {
- "description" : "Fetch values for a parameter on a public card.",
+ "description" : "Fetch `Segment` with ID.",
+ "operationId" : "get-api-segment-id",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "param-key",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -33460,35 +41986,89 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/card/{uuid}/params/{param-key}/values",
- "tags" : [ "/api/public" ]
- }
- },
- "/api/public/card/{uuid}/query" : {
- "get" : {
- "description" : "Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth\n credentials. Public sharing must be enabled.",
+ "summary" : "GET /api/segment/{id}",
+ "tags" : [ "/api/segment" ]
+ },
+ "put" : {
+ "description" : "Update a `Segment` with ID.",
+ "operationId" : "put-api-segment-id",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "uuid",
+ "name" : "id",
"required" : true,
"schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be a valid JSON string.",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "caveats" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "definition" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "points_of_interest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "revision_message" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "show_in_getting_started" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "revision_message" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33500,56 +42080,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/card/{uuid}/query",
- "tags" : [ "/api/public" ]
+ "summary" : "PUT /api/segment/{id}",
+ "tags" : [ "/api/segment" ]
}
},
- "/api/public/card/{uuid}/query/{export-format}" : {
+ "/api/segment/{id}/related" : {
"get" : {
- "description" : "Fetch a publicly-accessible Card and return query results in the specified format. Does not require auth\n credentials. Public sharing must be enabled.",
+ "description" : "Return related entities.",
+ "operationId" : "get-api-segment-id-related",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
+ "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",
+ "name" : "id",
"required" : true,
"schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be a valid JSON string.",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -33563,23 +42109,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/card/{uuid}/query/{export-format}",
- "tags" : [ "/api/public" ]
+ "summary" : "GET /api/segment/{id}/related",
+ "tags" : [ "/api/segment" ]
}
},
- "/api/public/dashboard/{uuid}" : {
- "get" : {
- "description" : "Fetch a publicly-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- } ],
+ "/api/session" : {
+ "delete" : {
+ "description" : "Logout.",
+ "operationId" : "delete-api-session",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33591,53 +42129,33 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/dashboard/{uuid}",
- "tags" : [ "/api/public" ]
- }
- },
- "/api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}" : {
- "get" : {
- "description" : "Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Public\n sharing must be enabled.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be a valid JSON string.",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "summary" : "DELETE /api/session",
+ "tags" : [ "/api/session" ]
+ },
+ "post" : {
+ "description" : "Login.",
+ "operationId" : "post-api-session",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "password" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "username" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "username", "password" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33649,74 +42167,26 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}",
- "tags" : [ "/api/public" ]
+ "summary" : "POST /api/session",
+ "tags" : [ "/api/session" ]
}
},
- "/api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{export-format}" : {
+ "/api/session/forgot_password" : {
"post" : {
- "description" : "Fetch the results of running a publicly-accessible Card belonging to a Dashboard and return the data in one of the\n export formats. Does not require auth credentials. Public sharing must be enabled.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "path",
- "name" : "export-format",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
- }
- } ],
+ "description" : "Send a reset email when user has forgotten their password.",
+ "operationId" : "post-api-session-forgot_password",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "format_rows" : {
- "default" : false,
- "type" : "boolean"
- },
- "parameters" : {
- "oneOf" : [ {
- "items" : {
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "pivot_results" : {
- "default" : false,
- "type" : "boolean"
+ "email" : {
+ "description" : "value must be a valid email address.",
+ "type" : "string"
}
},
- "required" : [ "format_rows", "pivot_results" ],
+ "required" : [ "email" ],
"type" : "object"
}
}
@@ -33733,40 +42203,31 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{export-format}",
- "tags" : [ "/api/public" ]
+ "summary" : "POST /api/session/forgot_password",
+ "tags" : [ "/api/session" ]
}
},
- "/api/public/dashboard/{uuid}/dashcard/{dashcard-id}/execute" : {
- "get" : {
- "description" : "Fetches the values for filling in execution parameters. Pass PK parameters and values to select.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be a valid JSON string.",
- "in" : "query",
- "name" : "parameters",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "/api/session/google_auth" : {
+ "post" : {
+ "description" : "Login with Google Auth.",
+ "operationId" : "post-api-session-google_auth",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "token" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "token" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33778,44 +42239,26 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/execute",
- "tags" : [ "/api/public" ]
- },
+ "summary" : "POST /api/session/google_auth",
+ "tags" : [ "/api/session" ]
+ }
+ },
+ "/api/session/password-check" : {
"post" : {
- "description" : "Execute the associated Action in the context of a `Dashboard` and `DashboardCard` that includes it.\n\n `parameters` should be the mapped dashboard parameters with values.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "Endpoint that checks if the supplied password meets the currently configured password complexity rules.",
+ "operationId" : "post-api-session-password-check",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "parameters" : {
- "oneOf" : [ {
- "additionalProperties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
+ "password" : {
+ "description" : "password is too common.",
+ "type" : "string"
}
},
+ "required" : [ "password" ],
"type" : "object"
}
}
@@ -33832,35 +42275,22 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/public/dashboard/{uuid}/dashcard/{dashcard-id}/execute",
- "tags" : [ "/api/public" ]
+ "summary" : "POST /api/session/password-check",
+ "tags" : [ "/api/session" ]
}
},
- "/api/public/dashboard/{uuid}/params/{param-key}/remapping" : {
+ "/api/session/password_reset_token_valid" : {
"get" : {
- "description" : "Fetch the remapped value for the given `value` of parameter with ID `:param-key` of dashboard with UUID `uuid`.",
+ "description" : "Check if a password reset token is valid and isn't expired.",
+ "operationId" : "get-api-session-password_reset_token_valid",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
+ "in" : "query",
+ "name" : "token",
"required" : true,
"schema" : {
"minLength" : 1,
"type" : "string"
}
- }, {
- "in" : "query",
- "name" : "value",
- "required" : true,
- "schema" : { }
} ],
"responses" : {
"2XX" : {
@@ -33873,39 +42303,55 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/dashboard/{uuid}/params/{param-key}/remapping",
- "tags" : [ "/api/public" ]
+ "summary" : "GET /api/session/password_reset_token_valid",
+ "tags" : [ "/api/session" ]
}
},
- "/api/public/dashboard/{uuid}/params/{param-key}/search/{query}" : {
+ "/api/session/properties" : {
"get" : {
- "description" : "Fetch filter values for dashboard parameter `param-key`, containing specified `query`.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
+ "description" : "Get all properties and their values. These are the specific `Settings` that are readable by the current user, or are\n public if no user is logged in.",
+ "operationId" : "get-api-session-properties",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- }, {
- "in" : "path",
- "name" : "query",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
+ },
+ "summary" : "GET /api/session/properties",
+ "tags" : [ "/api/session" ]
+ }
+ },
+ "/api/session/reset_password" : {
+ "post" : {
+ "description" : "Reset password with a reset token.",
+ "operationId" : "post-api-session-reset_password",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "password" : {
+ "description" : "password is too common.",
+ "type" : "string"
+ },
+ "token" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "token", "password" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33917,31 +42363,43 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/dashboard/{uuid}/params/{param-key}/search/{query}",
- "tags" : [ "/api/public" ]
+ "summary" : "POST /api/session/reset_password",
+ "tags" : [ "/api/session" ]
}
},
- "/api/public/dashboard/{uuid}/params/{param-key}/values" : {
+ "/api/setting" : {
"get" : {
- "description" : "Fetch filter values for dashboard parameter `param-key`.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
+ "description" : "Get all `Settings` and their values. You must be a superuser or have `setting` permission to do this.\n For non-superusers, a list of visible settings and values can be retrieved using the /api/session/properties endpoint.",
+ "operationId" : "get-api-setting",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- }, {
- "in" : "path",
- "name" : "param-key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
+ },
+ "summary" : "GET /api/setting",
+ "tags" : [ "/api/setting" ]
+ },
+ "put" : {
+ "description" : "Update multiple `Settings` values. If called by a non-superuser, only user-local settings can be updated.",
+ "operationId" : "put-api-setting",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "additionalProperties" : { },
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -33953,20 +42411,19 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/dashboard/{uuid}/params/{param-key}/values",
- "tags" : [ "/api/public" ]
+ "summary" : "PUT /api/setting",
+ "tags" : [ "/api/setting" ]
}
},
- "/api/public/document/{uuid}" : {
+ "/api/setting/{key}" : {
"get" : {
- "description" : "Fetch a publicly-accessible Document. Does not require auth credentials. Public sharing must be enabled.\n\n Returns a Document with sensitive fields removed (excludes collection_id, permissions, creator details, etc.).\n Includes all embedded Cards with their metadata hydrated so the frontend doesn't need to make separate\n requests for each card — just like public Dashboards do.",
+ "description" : "Fetch a single `Setting`.",
+ "operationId" : "get-api-setting-key",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "uuid",
+ "name" : "key",
"required" : true,
"schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"type" : "string"
}
} ],
@@ -33981,44 +42438,33 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/document/{uuid}",
- "tags" : [ "/api/public" ]
- }
- },
- "/api/public/document/{uuid}/card/{card-id}" : {
- "get" : {
- "description" : "Run a query for a Card that's embedded in a public Document. Doesn't require auth credentials. Public sharing must\n be enabled.",
+ "summary" : "GET /api/setting/{key}",
+ "tags" : [ "/api/setting" ]
+ },
+ "put" : {
+ "description" : "Create/update a `Setting`. If called by a non-admin, only user-local settings can be updated.\n This endpoint can also be used to delete Settings by passing `nil` for `:value`.",
+ "operationId" : "put-api-setting-key",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
"in" : "path",
- "name" : "uuid",
+ "name" : "key",
"required" : true,
"schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
"type" : "string"
}
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be a valid JSON string.",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "value" : { }
+ },
+ "required" : [ "value" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -34030,71 +42476,76 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/document/{uuid}/card/{card-id}",
- "tags" : [ "/api/public" ]
+ "summary" : "PUT /api/setting/{key}",
+ "tags" : [ "/api/setting" ]
}
},
- "/api/public/document/{uuid}/card/{card-id}/{export-format}" : {
+ "/api/setup" : {
"post" : {
- "description" : "Fetch a Card embedded in a public Document and return query results in the specified format.\n Does not require auth credentials. Public sharing must be enabled.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "path",
- "name" : "export-format",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.query-processor.schema.export-format"
- }
- } ],
+ "description" : "Special endpoint for creating the first user during setup. This endpoint both creates the user AND logs them in and\n returns a session ID. This endpoint can also be used to set specific settings from the setup flow.",
+ "operationId" : "post-api-setup",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "format_rows" : {
- "default" : false,
- "type" : "boolean"
- },
- "parameters" : {
- "oneOf" : [ {
- "anyOf" : [ {
- "items" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
- }, {
- "description" : "value must be a valid JSON string.",
+ "prefs" : {
+ "properties" : {
+ "site_locale" : {
+ "oneOf" : [ {
+ "description" : "String must be a valid two-letter ISO language or language-country code e.g. 'en' or 'en_US'.",
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "site_name" : {
+ "minLength" : 1,
"type" : "string"
- } ]
- }, {
- "type" : "null"
- } ]
+ }
+ },
+ "required" : [ "site_name" ],
+ "type" : "object"
},
- "pivot_results" : {
- "default" : false,
- "type" : "boolean"
+ "token" : {
+ "description" : "Token does not match the setup token.",
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "user" : {
+ "properties" : {
+ "email" : {
+ "description" : "value must be a valid email address.",
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "password" : {
+ "description" : "password is too common.",
+ "type" : "string"
+ }
+ },
+ "required" : [ "email", "password" ],
+ "type" : "object"
}
},
- "required" : [ "format_rows", "pivot_results" ],
+ "required" : [ "token", "user", "prefs" ],
"type" : "object"
}
}
@@ -34111,53 +42562,30 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/public/document/{uuid}/card/{card-id}/{export-format}",
- "tags" : [ "/api/public" ]
+ "summary" : "POST /api/setup",
+ "tags" : [ "/api/setup" ]
}
},
- "/api/public/oembed" : {
- "get" : {
- "description" : "oEmbed endpoint used to retrieve embed code and metadata for a (public) Metabase URL.",
- "parameters" : [ {
- "in" : "query",
- "name" : "url",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "description" : "The format param is not used by the API, but is required as part of the oEmbed spec: http://oembed.com/#section2 just return an error if `format` is specified and it's anything other than `json`.",
- "in" : "query",
- "name" : "format",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "enum" : [ "json" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "maxheight",
- "required" : true,
- "schema" : {
- "default" : 800,
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "maxwidth",
- "required" : true,
- "schema" : {
- "default" : 1024,
- "minimum" : 1,
- "type" : "integer"
+ "/api/slack/bug-report" : {
+ "post" : {
+ "description" : "Send diagnostic information to the configured Slack channels.",
+ "operationId" : "post-api-slack-bug-report",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "diagnosticInfo" : {
+ "type" : "object"
+ }
+ },
+ "required" : [ "diagnosticInfo" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -34169,35 +42597,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/oembed",
- "tags" : [ "/api/public" ]
+ "summary" : "POST /api/slack/bug-report",
+ "tags" : [ "/api/slack" ]
}
},
- "/api/public/pivot/card/{uuid}/query" : {
+ "/api/slack/manifest" : {
"get" : {
- "description" : "Fetch a publicly-accessible Card an return query results as well as `:card` information. Does not require auth\n credentials. Public sharing must be enabled.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be a valid JSON string.",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- } ],
+ "description" : "Returns the YAML manifest file that should be used to bootstrap new Slack apps",
+ "operationId" : "get-api-slack-manifest",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -34209,53 +42617,41 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/pivot/card/{uuid}/query",
- "tags" : [ "/api/public" ]
+ "summary" : "GET /api/slack/manifest",
+ "tags" : [ "/api/slack" ]
}
},
- "/api/public/pivot/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}" : {
- "get" : {
- "description" : "Fetch the results for a Card in a publicly-accessible Dashboard. Does not require auth credentials. Public\n sharing must be enabled.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be a valid JSON string.",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "/api/slack/settings" : {
+ "put" : {
+ "description" : "Update Slack related settings. You must be a superuser to do this. Also updates the slack-cache.\n There are 3 cases where we alter the slack channel/user cache:\n 1. falsy token -> clear\n 2. invalid token -> clear\n 3. truthy, valid token -> refresh ",
+ "operationId" : "put-api-slack-settings",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "slack-app-token" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "slack-bug-report-channel" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -34267,185 +42663,76 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/public/pivot/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}",
- "tags" : [ "/api/public" ]
+ "summary" : "PUT /api/slack/settings",
+ "tags" : [ "/api/slack" ]
}
},
- "/api/public/tiles/card/{uuid}/{zoom}/{x}/{y}" : {
+ "/api/table" : {
"get" : {
- "description" : "Generates a single tile image for a publicly-accessible Card using the map visualization. Does not require auth\n credentials. Public sharing must be enabled.",
+ "description" : "Get all `Tables`.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can execute queries against\n - `can-write=true` - filter to only tables the user can edit metadata for",
+ "operationId" : "get-api-table",
"parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer.",
- "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 a valid JSON string.",
"in" : "query",
- "name" : "parameters",
+ "name" : "term",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
- "name" : "latField",
- "required" : true,
+ "name" : "visibility-type",
+ "required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
- "name" : "lonField",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/public/tiles/card/{uuid}/{zoom}/{x}/{y}",
- "tags" : [ "/api/public" ]
- }
- },
- "/api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
- "get" : {
- "description" : "Generates a single tile image for a Card using the map visualization in a publicly-accessible Dashboard. Does not\n require auth credentials. Public sharing must be enabled.",
- "parameters" : [ {
- "description" : "value must be a valid UUID.",
- "in" : "path",
- "name" : "uuid",
- "required" : true,
- "schema" : {
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}",
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "zoom",
- "required" : true,
- "schema" : {
- "type" : "integer"
- }
- }, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "x",
- "required" : true,
+ "name" : "data-layer",
+ "required" : false,
"schema" : {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-layers"
}
}, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "y",
- "required" : true,
+ "in" : "query",
+ "name" : "data-source",
+ "required" : false,
"schema" : {
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-sources"
}
}, {
- "description" : "value must be a valid JSON string.",
"in" : "query",
- "name" : "parameters",
+ "name" : "owner-user-id",
"required" : false,
"schema" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "latField",
- "required" : true,
+ "name" : "owner-email",
+ "required" : false,
"schema" : {
"type" : "string"
}
}, {
"in" : "query",
- "name" : "lonField",
- "required" : true,
+ "name" : "orphan-only",
+ "required" : false,
"schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "summary" : "GET /api/public/tiles/dashboard/{uuid}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
- "tags" : [ "/api/public" ]
- }
- },
- "/api/pulse/" : {
- "get" : {
- "description" : "Fetch all dashboard subscriptions. By default, returns only subscriptions for which the current user has write\n permissions. For admins, this is all subscriptions; for non-admins, it is only subscriptions that they created.\n\n If `dashboard_id` is specified, restricts results to subscriptions for that dashboard.\n\n If `created_or_receive` is `true`, it specifically returns all subscriptions for which the current user\n created *or* is a known recipient of. Note that this is a superset of the default items returned for non-admins,\n and a subset of the default items returned for admins. This is used to power the /account/notifications page.\n This may include subscriptions which the current user does not have collection permissions for, in which case\n some sensitive metadata (the list of cards and recipients) is stripped out.",
- "parameters" : [ {
+ }, {
"in" : "query",
- "name" : "archived",
- "required" : true,
+ "name" : "unused-only",
+ "required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
"type" : "boolean"
}, {
@@ -34454,23 +42741,20 @@
}
}, {
"in" : "query",
- "name" : "dashboard_id",
+ "name" : "can-query",
"required" : false,
"schema" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "creator_or_recipient",
- "required" : true,
+ "name" : "can-write",
+ "required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
"type" : "boolean"
}, {
@@ -34489,71 +42773,114 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/pulse/",
- "tags" : [ "/api/pulse" ]
+ "summary" : "GET /api/table",
+ "tags" : [ "/api/table" ]
},
- "post" : {
- "description" : "Create a new `Pulse`.",
+ "put" : {
+ "description" : "Update all `Table` in `ids`.\n\n Deprecated, should use PUT /table/edit from now on.",
+ "operationId" : "put-api-table",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "cards" : { },
- "channels" : { },
- "collection_id" : {
+ "caveats" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "data_authority" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-authority-write"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "data_layer" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "data_source" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "collection_position" : {
+ "entity_type" : {
"oneOf" : [ {
+ "description" : "value must be a valid entity type (keyword or string)."
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "ids" : {
+ "items" : {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
"type" : "integer"
+ },
+ "type" : "array"
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "dashboard_id" : {
+ "owner_user_id" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
"type" : "integer"
}, {
"type" : "null"
} ]
},
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "parameters" : {
+ "points_of_interest" : {
"oneOf" : [ {
- "items" : {
- "properties" : { },
- "type" : "object"
- },
- "type" : "array"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "skip_if_empty" : {
- "default" : false,
+ "show_in_getting_started" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
+ },
+ "visibility_type" : {
+ "oneOf" : [ {
+ "enum" : [ "technical", "hidden", "cruft" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "name", "cards", "channels", "skip_if_empty" ],
+ "required" : [ "ids" ],
"type" : "object"
}
}
@@ -34570,32 +42897,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/pulse/",
- "tags" : [ "/api/pulse" ]
- }
- },
- "/api/pulse/form_input" : {
- "get" : {
- "description" : "Provides relevant configuration information and user choices for creating/updating Pulses.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/pulse/form_input",
- "tags" : [ "/api/pulse" ]
+ "summary" : "PUT /api/table",
+ "tags" : [ "/api/table" ]
}
},
- "/api/pulse/preview_card/{id}" : {
+ "/api/table/card__:id/fks" : {
"get" : {
- "description" : "Get HTML rendering of a Card with `id`.",
+ "description" : "Return FK info for the 'virtual' table for a Card. This is always empty, so this endpoint\n serves mainly as a placeholder to avoid having to change anything on the frontend.",
+ "operationId" : "get-api-table-card__:id-fks",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -34617,13 +42926,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/pulse/preview_card/{id}",
- "tags" : [ "/api/pulse" ]
+ "summary" : "GET /api/table/card__:id/fks",
+ "tags" : [ "/api/table" ]
}
},
- "/api/pulse/preview_card_info/{id}" : {
+ "/api/table/card__:id/query_metadata" : {
"get" : {
- "description" : "Get JSON object containing HTML rendering of a Card with `id` and other information.",
+ "description" : "Return metadata for the 'virtual' table for a Card.",
+ "operationId" : "get-api-table-card__:id-query_metadata",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -34645,13 +42955,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/pulse/preview_card_info/{id}",
- "tags" : [ "/api/pulse" ]
+ "summary" : "GET /api/table/card__:id/query_metadata",
+ "tags" : [ "/api/table" ]
}
},
- "/api/pulse/preview_card_png/{id}" : {
+ "/api/table/{id}" : {
"get" : {
- "description" : "Get PNG rendering of a Card with `id`. Optionally specify `width` as a query parameter.",
+ "description" : "Get `Table` with ID.",
+ "operationId" : "get-api-table-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -34663,13 +42974,11 @@
}
}, {
"in" : "query",
- "name" : "width",
+ "name" : "include_editable_data_model",
"required" : false,
"schema" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -34686,13 +42995,12 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/pulse/preview_card_png/{id}",
- "tags" : [ "/api/pulse" ]
- }
- },
- "/api/pulse/preview_dashboard/{id}" : {
- "get" : {
- "description" : "Get HTML rendering of a Dashboard with `id`.\n\n This endpoint relies on a custom middleware defined in `metabase.channel.render.core/style-tag-nonce-middleware` to\n allow the style tag to render properly, given our Content Security Policy setup. This middleware is attached to these\n routes at the bottom of this namespace using `metabase.api.common/define-routes`.",
+ "summary" : "GET /api/table/{id}",
+ "tags" : [ "/api/table" ]
+ },
+ "put" : {
+ "description" : "Update `Table` with ID.",
+ "operationId" : "put-api-table-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -34703,81 +43011,106 @@
"type" : "integer"
}
} ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/pulse/preview_dashboard/{id}",
- "tags" : [ "/api/pulse" ]
- }
- },
- "/api/pulse/test" : {
- "post" : {
- "description" : "Test send an unsaved pulse.",
- "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "cards" : { },
- "channels" : { },
- "collection_id" : {
+ "caveats" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "collection_position" : {
+ "data_authority" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-authority-write"
}, {
"type" : "null"
} ]
},
- "dashboard_id" : {
+ "data_layer" : {
"oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "disable_links" : {
- "default" : false,
+ "data_source" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "name" : {
- "minLength" : 1,
- "type" : "string"
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "skip_if_empty" : {
- "default" : false,
+ "display_name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_type" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid entity type (keyword or string)."
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "field_order" : {
+ "oneOf" : [ {
+ "enum" : [ "alphabetical", "custom", "database", "smart" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "points_of_interest" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "show_in_getting_started" : {
"oneOf" : [ {
"type" : "boolean"
}, {
"type" : "null"
} ]
+ },
+ "visibility_type" : {
+ "oneOf" : [ {
+ "enum" : [ "technical", "hidden", "cruft" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "name", "cards", "channels", "skip_if_empty", "disable_links" ],
"type" : "object"
}
}
@@ -34794,32 +43127,41 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/pulse/test",
- "tags" : [ "/api/pulse" ]
+ "summary" : "PUT /api/table/{id}",
+ "tags" : [ "/api/table" ]
}
},
- "/api/pulse/unsubscribe/" : {
+ "/api/table/{id}/append-csv" : {
"post" : {
- "description" : "Allow non-users to unsubscribe from pulses/subscriptions, with the hash given through email.",
- "parameters" : [ ],
+ "description" : "Inserts the rows of an uploaded CSV file into the table identified by `:id`. The table must have been created by\n uploading a CSV file.",
+ "operationId" : "post-api-table-id-append-csv",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
- "application/json" : {
+ "multipart/form-data" : {
"schema" : {
"properties" : {
- "email" : {
- "type" : "string"
- },
- "hash" : {
- "type" : "string"
- },
- "pulse-id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
+ "file" : {
+ "properties" : {
+ "filename" : {
+ "type" : "string"
+ },
+ "tempfile" : { }
+ },
+ "required" : [ "filename", "tempfile" ],
+ "type" : "object"
}
},
- "required" : [ "pulse-id", "email", "hash" ],
+ "required" : [ "file" ],
"type" : "object"
}
}
@@ -34836,39 +43178,82 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/pulse/unsubscribe/",
- "tags" : [ "/api/pulse/unsubscribe" ]
+ "summary" : "POST /api/table/{id}/append-csv",
+ "tags" : [ "/api/table" ]
}
},
- "/api/pulse/unsubscribe/undo" : {
+ "/api/table/{id}/discard_values" : {
"post" : {
- "description" : "Allow non-users to undo an unsubscribe from pulses/subscriptions, with the hash given through email.",
- "parameters" : [ ],
+ "description" : "Discard the FieldValues belonging to the Fields in this Table. Only applies to fields that have FieldValues. If\n this Table's Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.",
+ "operationId" : "post-api-table-id-discard_values",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/table/{id}/discard_values",
+ "tags" : [ "/api/table" ]
+ }
+ },
+ "/api/table/{id}/fields/order" : {
+ "put" : {
+ "description" : "Reorder fields",
+ "operationId" : "put-api-table-id-fields-order",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "properties" : {
- "email" : {
- "type" : "string"
- },
- "hash" : {
- "type" : "string"
- },
- "pulse-id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
},
- "required" : [ "pulse-id", "email", "hash" ],
- "type" : "object"
+ "type" : "array"
}
}
}
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "success" : {
+ "const" : true
+ }
+ },
+ "required" : [ "success" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -34878,13 +43263,14 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/pulse/unsubscribe/undo",
- "tags" : [ "/api/pulse/unsubscribe" ]
+ "summary" : "PUT /api/table/{id}/fields/order",
+ "tags" : [ "/api/table" ]
}
},
- "/api/pulse/{id}" : {
+ "/api/table/{id}/fks" : {
"get" : {
- "description" : "Fetch `Pulse` with ID. If the user is a recipient of the Pulse but does not have read permissions for its collection,\n we still return it but with some sensitive metadata removed.",
+ "description" : "Get all foreign keys whose destination is a `Field` that belongs to this `Table`.",
+ "operationId" : "get-api-table-id-fks",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -34906,11 +43292,108 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/pulse/{id}",
- "tags" : [ "/api/pulse" ]
- },
- "put" : {
- "description" : "Update a Pulse with `id`.",
+ "summary" : "GET /api/table/{id}/fks",
+ "tags" : [ "/api/table" ]
+ }
+ },
+ "/api/table/{id}/query_metadata" : {
+ "get" : {
+ "description" : "Get metadata about a `Table` useful for running queries.\n Returns DB, fields, field FKs, and field values.\n\n Passing `include_hidden_fields=true` will include any hidden `Fields` in the response. Defaults to `false`\n Passing `include_sensitive_fields=true` will include any sensitive `Fields` in the response. Defaults to `false`.\n\n Passing `include_editable_data_model=true` will check that the current user has write permissions for the table's\n data model, while `false` checks that they have data access perms for the table. Defaults to `false`.\n\n These options are provided for use in the Admin Edit Metadata page.",
+ "operationId" : "get-api-table-id-query_metadata",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "include_sensitive_fields",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include_hidden_fields",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "include_editable_data_model",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/table/{id}/query_metadata",
+ "tags" : [ "/api/table" ]
+ }
+ },
+ "/api/table/{id}/related" : {
+ "get" : {
+ "description" : "Return related entities.",
+ "operationId" : "get-api-table-id-related",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/table/{id}/related",
+ "tags" : [ "/api/table" ]
+ }
+ },
+ "/api/table/{id}/replace-csv" : {
+ "post" : {
+ "description" : "Replaces the contents of the table identified by `:id` with the rows of an uploaded CSV file. The table must have\n been created by uploading a CSV file.",
+ "operationId" : "post-api-table-id-replace-csv",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -34923,71 +43406,55 @@
} ],
"requestBody" : {
"content" : {
- "application/json" : {
+ "multipart/form-data" : {
"schema" : {
"properties" : {
- "archived" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "cards" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "channels" : {
- "oneOf" : [ { }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "parameters" : {
- "oneOf" : [ {
- "items" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
+ "file" : {
+ "properties" : {
+ "filename" : {
+ "type" : "string"
},
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- },
- "skip_if_empty" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "tempfile" : { }
+ },
+ "required" : [ "filename", "tempfile" ],
+ "type" : "object"
}
},
- "required" : [ "skip_if_empty", "archived" ],
+ "required" : [ "file" ],
"type" : "object"
}
}
}
- },
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "POST /api/table/{id}/replace-csv",
+ "tags" : [ "/api/table" ]
+ }
+ },
+ "/api/table/{id}/rescan_values" : {
+ "post" : {
+ "description" : "Manually trigger an update for the FieldValues for the Fields belonging to this Table. Only applies to Fields that\n are eligible for FieldValues.",
+ "operationId" : "post-api-table-id-rescan_values",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -34999,13 +43466,14 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/pulse/{id}",
- "tags" : [ "/api/pulse" ]
+ "summary" : "POST /api/table/{id}/rescan_values",
+ "tags" : [ "/api/table" ]
}
},
- "/api/pulse/{id}/subscription" : {
- "delete" : {
- "description" : "For users to unsubscribe themselves from a pulse subscription.",
+ "/api/table/{id}/sync_schema" : {
+ "post" : {
+ "description" : "Trigger a manual update of the schema metadata for this `Table`.",
+ "operationId" : "post-api-table-id-sync_schema",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -35027,30 +43495,23 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/pulse/{id}/subscription",
- "tags" : [ "/api/pulse" ]
+ "summary" : "POST /api/table/{id}/sync_schema",
+ "tags" : [ "/api/table" ]
}
},
- "/api/revision/" : {
+ "/api/table/{table-id}/data" : {
"get" : {
- "description" : "Get revisions of an object.",
+ "description" : "Get the data for the given table",
+ "operationId" : "get-api-table-table-id-data",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
- "in" : "query",
- "name" : "id",
+ "in" : "path",
+ "name" : "table-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "entity",
- "required" : true,
- "schema" : {
- "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ],
- "type" : "string"
- }
} ],
"responses" : {
"2XX" : {
@@ -35063,40 +43524,35 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/revision/",
- "tags" : [ "/api/revision" ]
+ "summary" : "GET /api/table/{table-id}/data",
+ "tags" : [ "/api/table" ]
}
},
- "/api/revision/revert" : {
- "post" : {
- "description" : "Revert an object to a prior revision.",
+ "/api/task" : {
+ "get" : {
+ "description" : "Fetch a list of recent tasks stored as Task History",
+ "operationId" : "get-api-task",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "entity" : {
- "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ],
- "type" : "string"
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "revision_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }
- },
- "required" : [ "id", "entity", "revision_id" ],
- "type" : "object"
- }
- }
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
+ "summary" : "GET /api/task",
+ "tags" : [ "/api/task" ]
+ }
+ },
+ "/api/task/info" : {
+ "get" : {
+ "description" : "Return raw data about all scheduled tasks (i.e., Quartz Jobs and Triggers).",
+ "operationId" : "get-api-task-info",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -35108,33 +43564,24 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/revision/revert",
- "tags" : [ "/api/revision" ]
+ "summary" : "GET /api/task/info",
+ "tags" : [ "/api/task" ]
}
},
- "/api/revision/{entity}/{id}" : {
+ "/api/task/runs" : {
"get" : {
- "description" : "Fetch `Revisions` for an object with ID.",
- "parameters" : [ {
- "in" : "path",
- "name" : "entity",
- "required" : true,
- "schema" : {
- "enum" : [ "card", "dashboard", "document", "measure", "segment", "transform" ],
- "type" : "string"
- }
- }, {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "List task runs with optional filters. Returns runs with hydrated entity names and task counts.",
+ "operationId" : "get-api-task-runs",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.task-history.api.TaskRunsResponse"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -35144,293 +43591,79 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/revision/{entity}/{id}",
- "tags" : [ "/api/revision" ]
+ "summary" : "GET /api/task/runs",
+ "tags" : [ "/api/task" ]
}
},
- "/api/search/" : {
+ "/api/task/runs/entities" : {
"get" : {
- "description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filters_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n - `non_temporal_dim_ids`: search for cards/metrics/datasets with this exact set of non temporal dimension field IDs (requires appdb engine)\n - `has_temporal_dim`: set to true for cards/metrics/datasets with 1 or more temporal dimensions (requires appdb engine)\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",
+ "description" : "Get distinct entities that have task runs for a given run type. Used for populating entity filter picker.",
+ "operationId" : "get-api-task-runs-entities",
"parameters" : [ {
"in" : "query",
- "name" : "q",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "context",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "archived",
+ "name" : "run-type",
"required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "collection",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "table_db_id",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "models",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "enum" : [ "dashboard", "table", "dataset", "segment", "collection", "measure", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ],
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "filter_items_in_personal_collection",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "enum" : [ "all", "only", "only-mine", "exclude", "exclude-others" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "created_at",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "created_by",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "display_type",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "minLength" : 1,
- "type" : "string"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "last_edited_at",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "last_edited_by",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
+ "enum" : [ "alert", "sync", "fingerprint", "subscription" ],
+ "type" : "string"
}
}, {
"in" : "query",
- "name" : "model_ancestors",
+ "name" : "started-at",
"required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "search_engine",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "search_native_query",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "verified",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "ids",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "calculate_available_models",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "minLength" : 1,
+ "type" : "string"
}
- }, {
- "in" : "query",
- "name" : "include_dashboard_questions",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ } ],
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.task-history.api.RunEntity"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- }, {
- "in" : "query",
- "name" : "include_metadata",
+ },
+ "summary" : "GET /api/task/runs/entities",
+ "tags" : [ "/api/task" ]
+ }
+ },
+ "/api/task/runs/{id}" : {
+ "get" : {
+ "description" : "Get a single task run with all its child tasks.",
+ "operationId" : "get-api-task-runs-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
"required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "non_temporal_dim_ids",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "has_temporal_dim",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.task-history.api.TaskRunWithTasks"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -35440,13 +43673,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/search/",
- "tags" : [ "/api/search" ]
+ "summary" : "GET /api/task/runs/{id}",
+ "tags" : [ "/api/task" ]
}
},
- "/api/search/force-reindex" : {
- "post" : {
- "description" : "This will trigger an immediate reindexing, if we are using search index.",
+ "/api/task/unique-tasks" : {
+ "get" : {
+ "description" : "Returns possibly empty vector of unique task names in alphabetical order. It is expected that number of unique\n tasks is small, hence no need for pagination. If that changes this endpoint and function that powers it should\n reflect that.",
+ "operationId" : "get-api-task-unique-tasks",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -35459,14 +43693,24 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/search/force-reindex",
- "tags" : [ "/api/search" ]
+ "summary" : "GET /api/task/unique-tasks",
+ "tags" : [ "/api/task" ]
}
},
- "/api/search/re-init" : {
- "post" : {
- "description" : "This will blow away any search indexes, re-create, and re-populate them.",
- "parameters" : [ ],
+ "/api/task/{id}" : {
+ "get" : {
+ "description" : "Get `TaskHistory` entry with ID.",
+ "operationId" : "get-api-task-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -35478,19 +43722,28 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/search/re-init",
- "tags" : [ "/api/search" ]
+ "summary" : "GET /api/task/{id}",
+ "tags" : [ "/api/task" ]
}
},
- "/api/search/weights" : {
+ "/api/testing/echo" : {
"get" : {
- "description" : "Return the current weights being used to rank the search results",
+ "description" : "Simple echo handler. Fails when you GET with `?fail=true`.",
+ "operationId" : "get-api-testing-echo",
"parameters" : [ {
"in" : "query",
- "name" : "context",
+ "name" : "fail",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "type" : "boolean"
+ }
+ }, {
+ "description" : "value must be a valid JSON string.",
+ "in" : "query",
+ "name" : "body",
"required" : true,
"schema" : {
- "default" : "default",
"type" : "string"
}
} ],
@@ -35505,24 +43758,20 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/search/weights",
- "tags" : [ "/api/search" ]
+ "summary" : "GET /api/testing/echo",
+ "tags" : [ "/api/testing" ]
},
- "put" : {
- "description" : "Update the current weights being used to rank the search results",
+ "post" : {
+ "description" : "Simple echo handler. Fails when you POST with `?fail=true`.",
+ "operationId" : "post-api-testing-echo",
"parameters" : [ {
"in" : "query",
- "name" : "context",
+ "name" : "fail",
"required" : true,
"schema" : {
- "default" : "default",
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "search_engine",
- "required" : false,
- "schema" : { }
+ "default" : false,
+ "type" : "boolean"
+ }
} ],
"responses" : {
"2XX" : {
@@ -35535,14 +43784,42 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/search/weights",
- "tags" : [ "/api/search" ]
+ "summary" : "POST /api/testing/echo",
+ "tags" : [ "/api/testing" ]
}
},
- "/api/segment/" : {
- "get" : {
- "description" : "Fetch *all* `Segments`.",
+ "/api/testing/mark-stale" : {
+ "post" : {
+ "description" : "Mark the card or dashboard as stale",
+ "operationId" : "post-api-testing-mark-stale",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "date-str" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "model" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "model" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -35554,40 +43831,36 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/segment/",
- "tags" : [ "/api/segment" ]
- },
+ "summary" : "POST /api/testing/mark-stale",
+ "tags" : [ "/api/testing" ]
+ }
+ },
+ "/api/testing/native-query" : {
"post" : {
- "description" : "Create a new `Segment`.",
+ "description" : "Creates a native query from a test query spec.",
+ "operationId" : "post-api-testing-native-query",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "definition" : {
- "description" : "Value must be a map.",
- "properties" : { },
- "type" : "object"
+ "database" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
- "description" : {
+ "query" : {
+ "type" : "string"
+ },
+ "template-tags" : {
+ "default" : { },
"oneOf" : [ {
- "type" : "string"
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-template-tags-spec"
}, {
"type" : "null"
} ]
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "table_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
}
},
- "required" : [ "name", "table_id", "definition" ],
+ "required" : [ "database", "query" ],
"type" : "object"
}
}
@@ -35595,6 +43868,13 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.query"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -35604,31 +43884,63 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/segment/",
- "tags" : [ "/api/segment" ]
+ "summary" : "POST /api/testing/native-query",
+ "tags" : [ "/api/testing" ]
}
},
- "/api/segment/{id}" : {
- "delete" : {
- "description" : "Archive a Segment. (DEPRECATED -- Just pass updated value of `:archived` to the `PUT` endpoint instead.)",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "/api/testing/query" : {
+ "post" : {
+ "description" : "Creates a query from a test query spec.",
+ "operationId" : "post-api-testing-query",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "database" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.database"
+ },
+ "stages" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.test-spec.test-stage-spec"
+ },
+ "type" : "array"
+ }
+ },
+ "required" : [ "database", "stages" ],
+ "type" : "object"
+ }
+ }
}
- }, {
- "in" : "query",
- "name" : "revision_message",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
+ },
+ "responses" : {
+ "2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.query"
+ }
+ }
+ },
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- } ],
+ },
+ "summary" : "POST /api/testing/query",
+ "tags" : [ "/api/testing" ]
+ }
+ },
+ "/api/testing/refresh-caches" : {
+ "post" : {
+ "description" : "Manually triggers the cache refresh task, if Enterprise code is available.",
+ "operationId" : "post-api-testing-refresh-caches",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -35640,19 +43952,21 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/segment/{id}",
- "tags" : [ "/api/segment" ]
- },
- "get" : {
- "description" : "Fetch `Segment` with ID.",
+ "summary" : "POST /api/testing/refresh-caches",
+ "tags" : [ "/api/testing" ]
+ }
+ },
+ "/api/testing/restore/{name}" : {
+ "post" : {
+ "description" : "Restore a database snapshot for testing purposes.",
+ "operationId" : "post-api-testing-restore-name",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "name",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "minLength" : 1,
+ "type" : "string"
}
} ],
"responses" : {
@@ -35666,83 +43980,37 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/segment/{id}",
- "tags" : [ "/api/segment" ]
- },
- "put" : {
- "description" : "Update a `Segment` with ID.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "summary" : "POST /api/testing/restore/{name}",
+ "tags" : [ "/api/testing" ]
+ }
+ },
+ "/api/testing/set-time" : {
+ "post" : {
+ "description" : "Make java-time see world at exact time.",
+ "operationId" : "post-api-testing-set-time",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "caveats" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "definition" : {
- "oneOf" : [ {
- "properties" : { },
- "type" : "object"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
+ "add-ms" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
+ "description" : "value must be an integer.",
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "points_of_interest" : {
+ "time" : {
"oneOf" : [ {
+ "description" : "value must be a valid date string",
"type" : "string"
}, {
"type" : "null"
} ]
- },
- "revision_message" : {
- "minLength" : 1,
- "type" : "string"
- },
- "show_in_getting_started" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
}
},
- "required" : [ "revision_message" ],
"type" : "object"
}
}
@@ -35759,21 +44027,21 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/segment/{id}",
- "tags" : [ "/api/segment" ]
+ "summary" : "POST /api/testing/set-time",
+ "tags" : [ "/api/testing" ]
}
},
- "/api/segment/{id}/related" : {
- "get" : {
- "description" : "Return related entities.",
+ "/api/testing/snapshot/{name}" : {
+ "post" : {
+ "description" : "Snapshot the database for testing purposes.",
+ "operationId" : "post-api-testing-snapshot-name",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "name",
"required" : true,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "minLength" : 1,
+ "type" : "string"
}
} ],
"responses" : {
@@ -35787,51 +44055,15 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/segment/{id}/related",
- "tags" : [ "/api/segment" ]
+ "summary" : "POST /api/testing/snapshot/{name}",
+ "tags" : [ "/api/testing" ]
}
},
- "/api/session/" : {
- "delete" : {
- "description" : "Logout.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "DELETE /api/session/",
- "tags" : [ "/api/session" ]
- },
+ "/api/testing/stats" : {
"post" : {
- "description" : "Login.",
+ "description" : "Triggers a send of instance usage stats",
+ "operationId" : "post-api-testing-stats",
"parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "password" : {
- "minLength" : 1,
- "type" : "string"
- },
- "username" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "username", "password" ],
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -35843,30 +44075,67 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/session/",
- "tags" : [ "/api/session" ]
+ "summary" : "POST /api/testing/stats",
+ "tags" : [ "/api/testing" ]
}
},
- "/api/session/forgot_password" : {
- "post" : {
- "description" : "Send a reset email when user has forgotten their password.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "email" : {
- "description" : "value must be a valid email address.",
- "type" : "string"
- }
- },
- "required" : [ "email" ],
- "type" : "object"
- }
- }
+ "/api/tiles/{card-id}/{zoom}/{x}/{y}" : {
+ "get" : {
+ "description" : "Generates a single tile image for a saved Card.",
+ "operationId" : "get-api-tiles-card-id-zoom-x-y",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
}
- },
+ }, {
+ "description" : "value must be an integer.",
+ "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"
+ }
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.parameters"
+ }
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -35878,30 +44147,81 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/session/forgot_password",
- "tags" : [ "/api/session" ]
+ "summary" : "GET /api/tiles/{card-id}/{zoom}/{x}/{y}",
+ "tags" : [ "/api/tiles" ]
}
},
- "/api/session/google_auth" : {
- "post" : {
- "description" : "Login with Google Auth.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "token" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "token" ],
- "type" : "object"
- }
- }
+ "/api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
+ "get" : {
+ "description" : "Generates a single tile image for a dashcard.",
+ "operationId" : "get-api-tiles-dashboard-id-dashcard-dashcard-id-card-card-id-zoom-x-y",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "dashboard-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
}
- },
+ }, {
+ "in" : "path",
+ "name" : "dashcard-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.dashcard"
+ }
+ }, {
+ "in" : "path",
+ "name" : "card-id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }
+ }, {
+ "description" : "value must be an integer.",
+ "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"
+ }
+ }, {
+ "in" : "query",
+ "name" : "parameters",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.parameters"
+ }
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ }
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -35913,30 +44233,60 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/session/google_auth",
- "tags" : [ "/api/session" ]
+ "summary" : "GET /api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
+ "tags" : [ "/api/tiles" ]
}
},
- "/api/session/password-check" : {
- "post" : {
- "description" : "Endpoint that checks if the supplied password meets the currently configured password complexity rules.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "password" : {
- "description" : "password is too common.",
- "type" : "string"
- }
- },
- "required" : [ "password" ],
- "type" : "object"
- }
- }
+ "/api/tiles/{zoom}/{x}/{y}" : {
+ "get" : {
+ "description" : "Generates a single tile image for an ad-hoc query.",
+ "operationId" : "get-api-tiles-zoom-x-y",
+ "parameters" : [ {
+ "description" : "value must be an integer.",
+ "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"
+ }
+ }, {
+ "in" : "query",
+ "name" : "query",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.query"
+ }
+ }, {
+ "in" : "query",
+ "name" : "latField",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
}
- },
+ }, {
+ "in" : "query",
+ "name" : "lonField",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -35948,24 +44298,42 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/session/password-check",
- "tags" : [ "/api/session" ]
+ "summary" : "GET /api/tiles/{zoom}/{x}/{y}",
+ "tags" : [ "/api/tiles" ]
}
},
- "/api/session/password_reset_token_valid" : {
+ "/api/timeline" : {
"get" : {
- "description" : "Check if a password reset token is valid and isn't expired.",
+ "description" : "Fetch a list of `Timeline`s. Can include `archived=true` to return archived timelines.",
+ "operationId" : "get-api-timeline",
"parameters" : [ {
"in" : "query",
- "name" : "token",
+ "name" : "include",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.timeline.api.timeline.include"
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "default" : false,
+ "type" : "boolean"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -35975,48 +44343,62 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/session/password_reset_token_valid",
- "tags" : [ "/api/session" ]
- }
- },
- "/api/session/properties" : {
- "get" : {
- "description" : "Get all properties and their values. These are the specific `Settings` that are readable by the current user, or are\n public if no user is logged in.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/session/properties",
- "tags" : [ "/api/session" ]
- }
- },
- "/api/session/reset_password" : {
+ "summary" : "GET /api/timeline",
+ "tags" : [ "/api/timeline" ]
+ },
"post" : {
- "description" : "Reset password with a reset token.",
+ "description" : "Create a new [[Timeline]].",
+ "operationId" : "post-api-timeline",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "password" : {
- "description" : "password is too common.",
- "type" : "string"
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "token" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "default" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "icon" : {
+ "oneOf" : [ {
+ "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
"minLength" : 1,
"type" : "string"
}
},
- "required" : [ "token", "password" ],
+ "required" : [ "name" ],
"type" : "object"
}
}
@@ -36024,6 +44406,13 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -36033,36 +44422,84 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/session/reset_password",
- "tags" : [ "/api/session" ]
+ "summary" : "POST /api/timeline",
+ "tags" : [ "/api/timeline" ]
}
},
- "/api/setting/" : {
- "get" : {
- "description" : "Get all `Settings` and their values. You must be a superuser or have `setting` permission to do this.\n For non-superusers, a list of visible settings and values can be retrieved using the /api/session/properties endpoint.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/setting/",
- "tags" : [ "/api/setting" ]
- },
- "put" : {
- "description" : "Update multiple `Settings` values. If called by a non-superuser, only user-local settings can be updated.",
+ "/api/timeline-event" : {
+ "post" : {
+ "description" : "Create a new [[TimelineEvent]].",
+ "operationId" : "post-api-timeline-event",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
- "additionalProperties" : { },
+ "properties" : {
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "icon" : {
+ "oneOf" : [ {
+ "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "question_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : {
+ "oneOf" : [ {
+ "enum" : [ "collections", "question" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "time_matters" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timeline_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "timestamp" : {
+ "description" : "value must be a valid date string",
+ "type" : "string"
+ },
+ "timezone" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "timestamp", "timezone", "timeline_id" ],
"type" : "object"
}
}
@@ -36079,19 +44516,22 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/setting/",
- "tags" : [ "/api/setting" ]
+ "summary" : "POST /api/timeline-event",
+ "tags" : [ "/api/timeline-event" ]
}
},
- "/api/setting/{key}" : {
- "get" : {
- "description" : "Fetch a single `Setting`.",
+ "/api/timeline-event/{id}" : {
+ "delete" : {
+ "description" : "Delete a [[TimelineEvent]].",
+ "operationId" : "delete-api-timeline-event-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "key",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
@@ -36105,32 +44545,22 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/setting/{key}",
- "tags" : [ "/api/setting" ]
+ "summary" : "DELETE /api/timeline-event/{id}",
+ "tags" : [ "/api/timeline-event" ]
},
- "put" : {
- "description" : "Create/update a `Setting`. If called by a non-admin, only user-local settings can be updated.\n This endpoint can also be used to delete Settings by passing `nil` for `:value`.",
+ "get" : {
+ "description" : "Fetch the [[TimelineEvent]] with `id`.",
+ "operationId" : "get-api-timeline-event-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "key",
+ "name" : "id",
"required" : true,
"schema" : {
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "value" : { }
- },
- "required" : [ "value" ],
- "type" : "object"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -36142,75 +44572,89 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/setting/{key}",
- "tags" : [ "/api/setting" ]
- }
- },
- "/api/setup/" : {
- "post" : {
- "description" : "Special endpoint for creating the first user during setup. This endpoint both creates the user AND logs them in and\n returns a session ID. This endpoint can also be used to set specific settings from the setup flow.",
- "parameters" : [ ],
+ "summary" : "GET /api/timeline-event/{id}",
+ "tags" : [ "/api/timeline-event" ]
+ },
+ "put" : {
+ "description" : "Update a [[TimelineEvent]].",
+ "operationId" : "put-api-timeline-event-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "prefs" : {
- "properties" : {
- "site_locale" : {
- "oneOf" : [ {
- "description" : "String must be a valid two-letter ISO language or language-country code e.g. 'en' or 'en_US'.",
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "site_name" : {
- "minLength" : 1,
- "type" : "string"
- }
- },
- "required" : [ "site_name" ],
- "type" : "object"
+ "archived" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
},
- "token" : {
- "description" : "Token does not match the setup token.",
- "minLength" : 1,
- "type" : "string"
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "user" : {
- "properties" : {
- "email" : {
- "description" : "value must be a valid email address.",
- "type" : "string"
- },
- "first_name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "last_name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "password" : {
- "description" : "password is too common.",
- "type" : "string"
- }
- },
- "required" : [ "email", "password" ],
- "type" : "object"
+ "icon" : {
+ "oneOf" : [ {
+ "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ],
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "time_matters" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timeline_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timestamp" : {
+ "oneOf" : [ {
+ "description" : "value must be a valid date string",
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "timezone" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
},
- "required" : [ "token", "user", "prefs" ],
"type" : "object"
}
}
@@ -36227,29 +44671,38 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/setup/",
- "tags" : [ "/api/setup" ]
+ "summary" : "PUT /api/timeline-event/{id}",
+ "tags" : [ "/api/timeline-event" ]
}
},
- "/api/slack/bug-report" : {
- "post" : {
- "description" : "Send diagnostic information to the configured Slack channels.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "diagnosticInfo" : {
- "type" : "object"
- }
- },
- "required" : [ "diagnosticInfo" ],
- "type" : "object"
- }
- }
+ "/api/timeline/collection/root" : {
+ "get" : {
+ "description" : "Fetch the root Collection's timelines.",
+ "operationId" : "get-api-timeline-collection-root",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "include",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "const" : "events"
+ }, {
+ "type" : "null"
+ } ]
}
- },
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -36261,59 +44714,47 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/slack/bug-report",
- "tags" : [ "/api/slack" ]
+ "summary" : "GET /api/timeline/collection/root",
+ "tags" : [ "/api/timeline" ]
}
},
- "/api/slack/manifest" : {
+ "/api/timeline/collection/{id}" : {
"get" : {
- "description" : "Returns the YAML manifest file that should be used to bootstrap new Slack apps",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "description" : "Fetch a specific Collection's timelines.",
+ "operationId" : "get-api-timeline-collection-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
}
- },
- "summary" : "GET /api/slack/manifest",
- "tags" : [ "/api/slack" ]
- }
- },
- "/api/slack/settings" : {
- "put" : {
- "description" : "Update Slack related settings. You must be a superuser to do this. Also updates the slack-cache.\n There are 3 cases where we alter the slack channel/user cache:\n 1. falsy token -> clear\n 2. invalid token -> clear\n 3. truthy, valid token -> refresh ",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "slack-app-token" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "slack-bug-report-channel" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
+ }, {
+ "in" : "query",
+ "name" : "include",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "const" : "events"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "archived",
+ "required" : true,
+ "schema" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
}
- },
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -36325,106 +44766,91 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/slack/settings",
- "tags" : [ "/api/slack" ]
+ "summary" : "GET /api/timeline/collection/{id}",
+ "tags" : [ "/api/timeline" ]
}
},
- "/api/table/" : {
- "get" : {
- "description" : "Get all `Tables`.\n\n Optional filters:\n - `can-query=true` - filter to only tables the user can execute queries against\n - `can-write=true` - filter to only tables the user can edit metadata for",
+ "/api/timeline/{id}" : {
+ "delete" : {
+ "description" : "Delete a [[Timeline]]. Will cascade delete its events as well.",
+ "operationId" : "delete-api-timeline-id",
"parameters" : [ {
- "in" : "query",
- "name" : "term",
- "required" : false,
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
"schema" : {
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "visibility-type",
- "required" : false,
- "schema" : {
- "type" : "string"
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
- }, {
- "in" : "query",
- "name" : "data-layer",
- "required" : false,
+ },
+ "summary" : "DELETE /api/timeline/{id}",
+ "tags" : [ "/api/timeline" ]
+ },
+ "get" : {
+ "description" : "Fetch the `Timeline` with `id`. Include `include=events` to unarchived events included on the timeline. Add\n `archived=true` to return all events on the timeline, both archived and unarchived.",
+ "operationId" : "get-api-timeline-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
"schema" : {
- "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-layers"
+ "minimum" : 1,
+ "type" : "integer"
}
}, {
"in" : "query",
- "name" : "data-source",
+ "name" : "include",
"required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-sources"
+ "$ref" : "#/components/schemas/metabase.timeline.api.timeline.include"
}
}, {
"in" : "query",
- "name" : "owner-user-id",
- "required" : false,
+ "name" : "archived",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
+ "default" : "false",
+ "type" : "boolean"
}
}, {
+ "description" : "value must be a valid date string",
"in" : "query",
- "name" : "owner-email",
+ "name" : "start",
"required" : false,
"schema" : {
"type" : "string"
}
}, {
+ "description" : "value must be a valid date string",
"in" : "query",
- "name" : "orphan-only",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "unused-only",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-query",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "can-write",
+ "name" : "end",
"required" : false,
"schema" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "type" : "string"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -36434,113 +44860,74 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/table/",
- "tags" : [ "/api/table" ]
+ "summary" : "GET /api/timeline/{id}",
+ "tags" : [ "/api/timeline" ]
},
"put" : {
- "description" : "Update all `Table` in `ids`.\n\n Deprecated, should use PUT /table/edit from now on.",
- "parameters" : [ ],
+ "description" : "Update the [[Timeline]] with `id`. Returns the timeline without events. Archiving a timeline will archive all of the\n events in that timeline.",
+ "operationId" : "put-api-timeline-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "caveats" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "data_authority" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-authority-write"
- }, {
- "type" : "null"
- } ]
- },
- "data_layer" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "data_source" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "display_name" : {
+ "archived" : {
"oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "entity_type" : {
+ "collection_id" : {
"oneOf" : [ {
- "description" : "value must be a valid entity type (keyword or string)."
- }, {
- "type" : "null"
- } ]
- },
- "ids" : {
- "items" : {
"description" : "value must be an integer greater than zero.",
"minimum" : 1,
"type" : "integer"
- },
- "type" : "array"
- },
- "owner_email" : {
- "oneOf" : [ {
- "type" : "string"
}, {
"type" : "null"
} ]
},
- "owner_user_id" : {
+ "default" : {
"oneOf" : [ {
- "type" : "integer"
+ "type" : "boolean"
}, {
"type" : "null"
} ]
},
- "points_of_interest" : {
+ "description" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "show_in_getting_started" : {
+ "icon" : {
"oneOf" : [ {
- "type" : "boolean"
+ "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ],
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "visibility_type" : {
+ "name" : {
"oneOf" : [ {
- "enum" : [ "technical", "hidden", "cruft" ],
+ "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
} ]
}
},
- "required" : [ "ids" ],
"type" : "object"
}
}
@@ -36557,85 +44944,66 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/table/",
- "tags" : [ "/api/table" ]
+ "summary" : "PUT /api/timeline/{id}",
+ "tags" : [ "/api/timeline" ]
}
},
- "/api/table/card__:id/fks" : {
+ "/api/transform" : {
"get" : {
- "description" : "Return FK info for the 'virtual' table for a Card. This is always empty, so this endpoint\n serves mainly as a placeholder to avoid having to change anything on the frontend.",
+ "description" : "Get a list of transforms.",
+ "operationId" : "get-api-transform",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
+ "in" : "query",
+ "name" : "last-run-start-time",
+ "required" : false,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "summary" : "GET /api/table/card__:id/fks",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/card__:id/query_metadata" : {
- "get" : {
- "description" : "Return metadata for the 'virtual' table for a Card.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
+ }, {
+ "in" : "query",
+ "name" : "last-run-statuses",
+ "required" : false,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
+ "oneOf" : [ {
+ "items" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
- },
- "summary" : "GET /api/table/card__:id/query_metadata",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/{id}" : {
- "get" : {
- "description" : "Get `Table` with ID.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
+ }, {
+ "in" : "query",
+ "name" : "tag-ids",
+ "required" : false,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "oneOf" : [ {
+ "items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "include_editable_data_model",
+ "name" : "database-id",
"required" : false,
"schema" : {
"oneOf" : [ {
- "type" : "boolean"
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
@@ -36643,6 +45011,285 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "creator" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : { },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "is_qbnewb" : {
+ "type" : "boolean"
+ },
+ "is_superuser" : {
+ "type" : "boolean"
+ },
+ "last_login" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tenant_id" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name" ],
+ "type" : "object"
+ },
+ "creator_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "dependency_analysis_version" : {
+ "type" : "integer"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ],
+ "type" : "string"
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "email" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : { },
+ "source_database_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_readable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_type" : {
+ "type" : "string"
+ },
+ "table" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "target" : { },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -36652,50 +45299,23 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/table/{id}",
- "tags" : [ "/api/table" ]
+ "summary" : "GET /api/transform",
+ "tags" : [ "/api/transform" ]
},
- "put" : {
- "description" : "Update `Table` with ID.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "post" : {
+ "description" : "Create a new transform.",
+ "operationId" : "post-api-transform",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "caveats" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "data_authority" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-authority-write"
- }, {
- "type" : "null"
- } ]
- },
- "data_layer" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "data_source" : {
+ "collection_id" : {
"oneOf" : [ {
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
@@ -36707,28 +45327,8 @@
"type" : "null"
} ]
},
- "display_name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "entity_type" : {
- "oneOf" : [ {
- "description" : "value must be a valid entity type (keyword or string)."
- }, {
- "type" : "null"
- } ]
- },
- "field_order" : {
- "oneOf" : [ {
- "enum" : [ "alphabetical", "custom", "database", "smart" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "name" : {
+ "type" : "string"
},
"owner_email" : {
"oneOf" : [ {
@@ -36739,170 +45339,311 @@
},
"owner_user_id" : {
"oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
"type" : "integer"
}, {
"type" : "null"
} ]
},
- "points_of_interest" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
+ "run_trigger" : {
+ "$ref" : "#/components/schemas/metabase.transforms-rest.api.transform.run-trigger"
},
- "show_in_getting_started" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "source" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
},
- "visibility_type" : {
- "oneOf" : [ {
- "enum" : [ "technical", "hidden", "cruft" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "PUT /api/table/{id}",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/{id}/append-csv" : {
- "post" : {
- "description" : "Inserts the rows of an uploaded CSV file into the table identified by `:id`. The table must have been created by\n uploading a CSV file.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "requestBody" : {
- "content" : {
- "multipart/form-data" : {
- "schema" : {
- "properties" : {
- "file" : {
- "properties" : {
- "filename" : {
- "type" : "string"
- },
- "tempfile" : { }
+ "tag_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
},
- "required" : [ "filename", "tempfile" ],
- "type" : "object"
+ "type" : "array"
+ },
+ "target" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
}
},
- "required" : [ "file" ],
+ "required" : [ "name", "source", "target" ],
"type" : "object"
}
}
}
},
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/table/{id}/append-csv",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/{id}/discard_values" : {
- "post" : {
- "description" : "Discard the FieldValues belonging to the Fields in this Table. Only applies to fields that have FieldValues. If\n this Table's Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/table/{id}/discard_values",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/{id}/fields/order" : {
- "put" : {
- "description" : "Reorder fields",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "type" : "array"
- }
- }
- }
- },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
+ "additionalProperties" : false,
"properties" : {
- "success" : {
- "const" : true
- }
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "creator" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : { },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "is_qbnewb" : {
+ "type" : "boolean"
+ },
+ "is_superuser" : {
+ "type" : "boolean"
+ },
+ "last_login" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tenant_id" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name" ],
+ "type" : "object"
+ },
+ "creator_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "dependency_analysis_version" : {
+ "type" : "integer"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ],
+ "type" : "string"
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "email" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : { },
+ "source_database_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_readable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_type" : {
+ "type" : "string"
+ },
+ "table" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "target" : { },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : { }
},
- "required" : [ "success" ],
+ "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
"type" : "object"
}
}
@@ -36916,82 +45657,65 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/table/{id}/fields/order",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/{id}/fks" : {
- "get" : {
- "description" : "Get all foreign keys whose destination is a `Field` that belongs to this `Table`.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/table/{id}/fks",
- "tags" : [ "/api/table" ]
+ "summary" : "POST /api/transform",
+ "tags" : [ "/api/transform" ]
}
},
- "/api/table/{id}/query_metadata" : {
+ "/api/transform-job" : {
"get" : {
- "description" : "Get metadata about a `Table` useful for running queries.\n Returns DB, fields, field FKs, and field values.\n\n Passing `include_hidden_fields=true` will include any hidden `Fields` in the response. Defaults to `false`\n Passing `include_sensitive_fields=true` will include any sensitive `Fields` in the response. Defaults to `false`.\n\n Passing `include_editable_data_model=true` will check that the current user has write permissions for the table's\n data model, while `false` checks that they have data access perms for the table. Defaults to `false`.\n\n These options are provided for use in the Admin Edit Metadata page.",
+ "description" : "Get all transform jobs.",
+ "operationId" : "get-api-transform-job",
"parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
+ "in" : "query",
+ "name" : "last-run-start-time",
+ "required" : false,
"schema" : {
- "minimum" : 1,
- "type" : "integer"
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "include_sensitive_fields",
- "required" : true,
+ "name" : "next-run-start-time",
+ "required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "minLength" : 1,
+ "type" : "string"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "include_hidden_fields",
- "required" : true,
+ "name" : "last-run-statuses",
+ "required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "items" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout" ],
+ "type" : "string"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
}
}, {
"in" : "query",
- "name" : "include_editable_data_model",
- "required" : true,
+ "name" : "tag-ids",
+ "required" : false,
"schema" : {
- "default" : false,
"oneOf" : [ {
- "type" : "boolean"
+ "items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "type" : "array"
}, {
"type" : "null"
} ]
@@ -36999,6 +45723,132 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "built_in_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "description" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "created_at" : { },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "job_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout" ],
+ "type" : "string"
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ },
+ "next_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "start_time" : { }
+ },
+ "required" : [ "start_time" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule" : {
+ "type" : "string"
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "ui_display_type" : {
+ "enum" : [ "cron/raw", "cron/builder" ],
+ "type" : "string"
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37008,68 +45858,49 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/table/{id}/query_metadata",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/{id}/related" : {
- "get" : {
- "description" : "Return related entities.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/table/{id}/related",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/{id}/replace-csv" : {
+ "summary" : "GET /api/transform-job",
+ "tags" : [ "/api/transform-job" ]
+ },
"post" : {
- "description" : "Replaces the contents of the table identified by `:id` with the rows of an uploaded CSV file. The table must have\n been created by uploading a CSV file.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
+ "description" : "Create a new transform job.",
+ "operationId" : "post-api-transform-job",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
- "multipart/form-data" : {
+ "application/json" : {
"schema" : {
"properties" : {
- "file" : {
- "properties" : {
- "filename" : {
- "type" : "string"
- },
- "tempfile" : { }
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "schedule" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "tag_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
},
- "required" : [ "filename", "tempfile" ],
- "type" : "object"
+ "type" : "array"
+ },
+ "ui_display_type" : {
+ "default" : "cron/raw",
+ "enum" : [ "cron/raw", "cron/builder" ],
+ "type" : "string"
}
},
- "required" : [ "file" ],
+ "required" : [ "name", "schedule", "ui_display_type" ],
"type" : "object"
}
}
@@ -37077,6 +45908,129 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "built_in_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "description" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "created_at" : { },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "job_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout" ],
+ "type" : "string"
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ },
+ "next_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "start_time" : { }
+ },
+ "required" : [ "start_time" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule" : {
+ "type" : "string"
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "ui_display_type" : {
+ "enum" : [ "cron/raw", "cron/builder" ],
+ "type" : "string"
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37086,45 +46040,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/table/{id}/replace-csv",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/{id}/rescan_values" : {
- "post" : {
- "description" : "Manually trigger an update for the FieldValues for the Fields belonging to this Table. Only applies to Fields that\n are eligible for FieldValues.",
- "parameters" : [ {
- "description" : "value must be an integer greater than zero.",
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "minimum" : 1,
- "type" : "integer"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/table/{id}/rescan_values",
- "tags" : [ "/api/table" ]
+ "summary" : "POST /api/transform-job",
+ "tags" : [ "/api/transform-job" ]
}
},
- "/api/table/{id}/sync_schema" : {
- "post" : {
- "description" : "Trigger a manual update of the schema metadata for this `Table`.",
+ "/api/transform-job/{job-id}" : {
+ "delete" : {
+ "description" : "Delete a transform job.",
+ "operationId" : "delete-api-transform-job-job-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "job-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -37142,123 +46069,144 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/table/{id}/sync_schema",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/table/{table-id}/data" : {
+ "summary" : "DELETE /api/transform-job/{job-id}",
+ "tags" : [ "/api/transform-job" ]
+ },
"get" : {
- "description" : "Get the data for the given table",
+ "description" : "Get a transform job by ID.",
+ "operationId" : "get-api-transform-job-job-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "table-id",
+ "name" : "job-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
} ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/table/{table-id}/data",
- "tags" : [ "/api/table" ]
- }
- },
- "/api/task/" : {
- "get" : {
- "description" : "Fetch a list of recent tasks stored as Task History",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/task/",
- "tags" : [ "/api/task" ]
- }
- },
- "/api/task/info" : {
- "get" : {
- "description" : "Return raw data about all scheduled tasks (i.e., Quartz Jobs and Triggers).",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/task/info",
- "tags" : [ "/api/task" ]
- }
- },
- "/api/task/runs" : {
- "get" : {
- "description" : "List task runs with optional filters. Returns runs with hydrated entity names and task counts.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "$ref" : "#/components/schemas/metabase.task-history.api.TaskRunsResponse"
- }
- }
- },
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/task/runs",
- "tags" : [ "/api/task" ]
- }
- },
- "/api/task/runs/entities" : {
- "get" : {
- "description" : "Get distinct entities that have task runs for a given run type. Used for populating entity filter picker.",
- "parameters" : [ {
- "in" : "query",
- "name" : "run-type",
- "required" : true,
- "schema" : {
- "enum" : [ "alert", "sync", "fingerprint", "subscription" ],
- "type" : "string"
- }
- } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.task-history.api.RunEntity"
+ "additionalProperties" : false,
+ "properties" : {
+ "built_in_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "description" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "created_at" : { },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "job_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout" ],
+ "type" : "string"
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ },
+ "next_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "start_time" : { }
+ },
+ "required" : [ "start_time" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule" : {
+ "type" : "string"
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "ui_display_type" : {
+ "enum" : [ "cron/raw", "cron/builder" ],
+ "type" : "string"
+ },
+ "updated_at" : { }
},
- "type" : "array"
+ "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
+ "type" : "object"
}
}
},
@@ -37271,29 +46219,183 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/task/runs/entities",
- "tags" : [ "/api/task" ]
- }
- },
- "/api/task/runs/{id}" : {
- "get" : {
- "description" : "Get a single task run with all its child tasks.",
+ "summary" : "GET /api/transform-job/{job-id}",
+ "tags" : [ "/api/transform-job" ]
+ },
+ "put" : {
+ "description" : "Update a transform job.",
+ "operationId" : "put-api-transform-job-job-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "job-id",
"required" : true,
"schema" : {
"minimum" : 1,
"type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "description" : {
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "schedule" : {
+ "minLength" : 1,
+ "type" : "string"
+ },
+ "tag_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "ui_display_type" : {
+ "enum" : [ "cron/raw", "cron/builder" ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.task-history.api.TaskRunWithTasks"
+ "additionalProperties" : false,
+ "properties" : {
+ "built_in_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "description" : {
+ "oneOf" : [ {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "created_at" : { },
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "job_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout" ],
+ "type" : "string"
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "job_id", "run_method", "status", "is_active", "start_time", "message", "created_at", "updated_at" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ },
+ "next_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "start_time" : { }
+ },
+ "required" : [ "start_time" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "schedule" : {
+ "type" : "string"
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "ui_display_type" : {
+ "enum" : [ "cron/raw", "cron/builder" ],
+ "type" : "string"
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "description", "schedule", "ui_display_type", "entity_id", "created_at", "updated_at" ],
+ "type" : "object"
}
}
},
@@ -37306,36 +46408,18 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/task/runs/{id}",
- "tags" : [ "/api/task" ]
- }
- },
- "/api/task/unique-tasks" : {
- "get" : {
- "description" : "Returns possibly empty vector of unique task names in alphabetical order. It is expected that number of unique\n tasks is small, hence no need for pagination. If that changes this endpoint and function that powers it should\n reflect that.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/task/unique-tasks",
- "tags" : [ "/api/task" ]
+ "summary" : "PUT /api/transform-job/{job-id}",
+ "tags" : [ "/api/transform-job" ]
}
},
- "/api/task/{id}" : {
- "get" : {
- "description" : "Get `TaskHistory` entry with ID.",
+ "/api/transform-job/{job-id}/run" : {
+ "post" : {
+ "description" : "Run a transform job manually.",
+ "operationId" : "post-api-transform-job-job-id-run",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "job-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -37344,6 +46428,23 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "job_run_id" : {
+ "type" : "string"
+ },
+ "message" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "message", "job_run_id" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37353,32 +46454,146 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/task/{id}",
- "tags" : [ "/api/task" ]
+ "summary" : "POST /api/transform-job/{job-id}/run",
+ "tags" : [ "/api/transform-job" ]
}
},
- "/api/testing/echo" : {
+ "/api/transform-job/{job-id}/transforms" : {
"get" : {
- "description" : "Simple echo handler. Fails when you GET with `?fail=true`.",
+ "description" : "Get the transforms of job specified by the job's ID.",
+ "operationId" : "get-api-transform-job-job-id-transforms",
"parameters" : [ {
- "in" : "query",
- "name" : "fail",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- }, {
- "description" : "value must be a valid JSON string.",
- "in" : "query",
- "name" : "body",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "job-id",
"required" : true,
"schema" : {
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "properties" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "creator" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : { },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "is_qbnewb" : {
+ "type" : "boolean"
+ },
+ "is_superuser" : {
+ "type" : "boolean"
+ },
+ "last_login" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tenant_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name" ],
+ "type" : "object"
+ },
+ "creator_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "dependency_analysis_version" : {
+ "type" : "integer"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : { },
+ "source_type" : {
+ "type" : "string"
+ },
+ "target" : { },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37388,22 +46603,61 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/testing/echo",
- "tags" : [ "/api/testing" ]
- },
- "post" : {
- "description" : "Simple echo handler. Fails when you POST with `?fail=true`.",
- "parameters" : [ {
- "in" : "query",
- "name" : "fail",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- } ],
+ "summary" : "GET /api/transform-job/{job-id}/transforms",
+ "tags" : [ "/api/transform-job" ]
+ }
+ },
+ "/api/transform-tag" : {
+ "get" : {
+ "description" : "Get a list of all transform tags.",
+ "operationId" : "get-api-transform-tag",
+ "parameters" : [ ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "built_in_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_run" : {
+ "type" : "boolean"
+ },
+ "created_at" : { },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "entity_id", "created_at", "updated_at" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37413,36 +46667,24 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/testing/echo",
- "tags" : [ "/api/testing" ]
- }
- },
- "/api/testing/mark-stale" : {
+ "summary" : "GET /api/transform-tag",
+ "tags" : [ "/api/transform-tag" ]
+ },
"post" : {
- "description" : "Mark the card or dashboard as stale",
+ "description" : "Create a new transform tag.",
+ "operationId" : "post-api-transform-tag",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "date-str" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "model" : {
+ "name" : {
+ "minLength" : 1,
"type" : "string"
}
},
- "required" : [ "id", "model" ],
+ "required" : [ "name" ],
"type" : "object"
}
}
@@ -37450,6 +46692,47 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "built_in_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_run" : {
+ "type" : "boolean"
+ },
+ "created_at" : { },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "entity_id", "created_at", "updated_at" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37459,43 +46742,33 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/testing/mark-stale",
- "tags" : [ "/api/testing" ]
- }
- },
- "/api/testing/refresh-caches" : {
- "post" : {
- "description" : "Manually triggers the cache refresh task, if Enterprise code is available.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/testing/refresh-caches",
- "tags" : [ "/api/testing" ]
+ "summary" : "POST /api/transform-tag",
+ "tags" : [ "/api/transform-tag" ]
}
},
- "/api/testing/restore/{name}" : {
- "post" : {
- "description" : "Restore a database snapshot for testing purposes.",
+ "/api/transform-tag/{tag-id}" : {
+ "delete" : {
+ "description" : "Delete a transform tag. Removes it from all transforms and jobs.",
+ "operationId" : "delete-api-transform-tag-tag-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "name",
+ "name" : "tag-id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37505,70 +46778,81 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/testing/restore/{name}",
- "tags" : [ "/api/testing" ]
- }
- },
- "/api/testing/set-time" : {
- "post" : {
- "description" : "Make java-time see world at exact time.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "add-ms" : {
- "oneOf" : [ {
- "description" : "value must be an integer.",
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "time" : {
- "oneOf" : [ {
- "description" : "value must be a valid date string",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "POST /api/testing/set-time",
- "tags" : [ "/api/testing" ]
- }
- },
- "/api/testing/snapshot/{name}" : {
- "post" : {
- "description" : "Snapshot the database for testing purposes.",
+ "summary" : "DELETE /api/transform-tag/{tag-id}",
+ "tags" : [ "/api/transform-tag" ]
+ },
+ "put" : {
+ "description" : "Update a transform tag.",
+ "operationId" : "put-api-transform-tag-tag-id",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "name",
+ "name" : "tag-id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "name" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ },
+ "required" : [ "name" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "built_in_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "can_run" : {
+ "type" : "boolean"
+ },
+ "created_at" : { },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "anyOf" : [ {
+ "type" : "string"
+ }, {
+ "anyOf" : [ { }, { } ]
+ } ]
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "entity_id", "created_at", "updated_at" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37578,16 +46862,52 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/testing/snapshot/{name}",
- "tags" : [ "/api/testing" ]
+ "summary" : "PUT /api/transform-tag/{tag-id}",
+ "tags" : [ "/api/transform-tag" ]
}
},
- "/api/testing/stats" : {
+ "/api/transform/extract-columns" : {
"post" : {
- "description" : "Triggers a send of instance usage stats",
+ "description" : "Extract column names suitable for incremental transform checkpoint filtering.\n\n This endpoint is specifically for populating the checkpoint column dropdown in\n incremental transforms. It only returns columns with types supported for checkpoint\n filtering: temporal (timestamp/tz) and numeric (int/float) types.\n\n Text, boolean, and other unsupported column types are filtered out.\n\n The query is compiled to native SQL using [[qp.compile/compile-with-inline-parameters]],\n which handles parameterized queries with template tags. Then extracts column names\n and types using PreparedStatement metadata.\n\n Returns a map with a :columns key containing a vector of column names (strings).\n If extraction fails, returns nil for :columns.",
+ "operationId" : "post-api-transform-extract-columns",
"parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "query" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.any-query"
+ }
+ },
+ "required" : [ "query" ],
+ "type" : "object"
+ }
+ }
+ }
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "columns" : {
+ "oneOf" : [ {
+ "items" : {
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "columns" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37597,68 +46917,48 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/testing/stats",
- "tags" : [ "/api/testing" ]
+ "summary" : "POST /api/transform/extract-columns",
+ "tags" : [ "/api/transform" ]
}
},
- "/api/tiles/{card-id}/{zoom}/{x}/{y}" : {
- "get" : {
- "description" : "Generates a single tile image for a saved Card.",
- "parameters" : [ {
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }
- }, {
- "description" : "value must be an integer.",
- "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"
- }
- }, {
- "in" : "query",
- "name" : "parameters",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.parameters"
- }
- }, {
- "in" : "query",
- "name" : "latField",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
- }
- }, {
- "in" : "query",
- "name" : "lonField",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ "/api/transform/is-simple-query" : {
+ "post" : {
+ "description" : "Checks if a native SQL query string is simple enough for automatic checkpoint insertion",
+ "operationId" : "post-api-transform-is-simple-query",
+ "parameters" : [ ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "query" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "query" ],
+ "type" : "object"
+ }
+ }
}
- } ],
+ },
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "is_simple" : {
+ "type" : "boolean"
+ },
+ "reason" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "is_simple" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37668,239 +46968,254 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/tiles/{card-id}/{zoom}/{x}/{y}",
- "tags" : [ "/api/tiles" ]
+ "summary" : "POST /api/transform/is-simple-query",
+ "tags" : [ "/api/transform" ]
}
},
- "/api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}" : {
+ "/api/transform/run" : {
"get" : {
- "description" : "Generates a single tile image for a dashcard.",
+ "description" : "Get transform runs based on a set of filter params.",
+ "operationId" : "get-api-transform-run",
"parameters" : [ {
- "in" : "path",
- "name" : "dashboard-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dashboard"
- }
- }, {
- "in" : "path",
- "name" : "dashcard-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.dashcard"
- }
- }, {
- "in" : "path",
- "name" : "card-id",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- }
- }, {
- "description" : "value must be an integer.",
- "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"
- }
- }, {
"in" : "query",
- "name" : "parameters",
+ "name" : "sort-column",
"required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.parameters"
+ "enum" : [ "transform-name", "start-time", "end-time", "status", "run-method", "transform-tags" ],
+ "type" : "string"
}
}, {
"in" : "query",
- "name" : "latField",
- "required" : true,
+ "name" : "sort-direction",
+ "required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ "enum" : [ "asc", "desc" ],
+ "type" : "string"
}
}, {
"in" : "query",
- "name" : "lonField",
- "required" : true,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
- }
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/tiles/{dashboard-id}/dashcard/{dashcard-id}/card/{card-id}/{zoom}/{x}/{y}",
- "tags" : [ "/api/tiles" ]
- }
- },
- "/api/tiles/{zoom}/{x}/{y}" : {
- "get" : {
- "description" : "Generates a single tile image for an ad-hoc query.",
- "parameters" : [ {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "zoom",
- "required" : true,
+ "name" : "transform-ids",
+ "required" : false,
"schema" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "x",
- "required" : true,
+ "in" : "query",
+ "name" : "statuses",
+ "required" : false,
"schema" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "items" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
- "description" : "value must be an integer.",
- "in" : "path",
- "name" : "y",
- "required" : true,
+ "in" : "query",
+ "name" : "transform-tag-ids",
+ "required" : false,
"schema" : {
- "type" : "integer"
+ "oneOf" : [ {
+ "items" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "minimum" : 0,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "query",
- "required" : true,
+ "name" : "start-time",
+ "required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.query"
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "latField",
- "required" : true,
+ "name" : "end-time",
+ "required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ "oneOf" : [ {
+ "minLength" : 1,
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
}
}, {
"in" : "query",
- "name" : "lonField",
- "required" : true,
+ "name" : "run-methods",
+ "required" : false,
"schema" : {
- "$ref" : "#/components/schemas/metabase.tiles.api.legacy-ref"
+ "oneOf" : [ {
+ "items" : {
+ "enum" : [ "manual", "cron" ],
+ "type" : "string"
+ },
+ "type" : "array"
+ }, {
+ "type" : "null"
+ } ]
}
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "GET /api/tiles/{zoom}/{x}/{y}",
- "tags" : [ "/api/tiles" ]
- }
- },
- "/api/timeline-event/" : {
- "post" : {
- "description" : "Create a new [[TimelineEvent]].",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "icon" : {
- "oneOf" : [ {
- "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "minLength" : 1,
- "type" : "string"
- },
- "question_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "data" : {
+ "items" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ],
+ "type" : "string"
+ },
+ "transform" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "collection" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "deleted" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ },
+ "limit" : {
"minimum" : 1,
"type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "source" : {
- "oneOf" : [ {
- "enum" : [ "collections", "question" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "time_matters" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "timeline_id" : {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- },
- "timestamp" : {
- "description" : "value must be a valid date string",
- "type" : "string"
+ },
+ "offset" : {
+ "type" : "integer"
+ },
+ "total" : {
+ "type" : "integer"
+ }
},
- "timezone" : {
- "type" : "string"
- }
- },
- "required" : [ "name", "timestamp", "timezone", "timeline_id" ],
- "type" : "object"
+ "required" : [ "data", "limit", "offset", "total" ],
+ "type" : "object"
+ }
}
- }
- }
- },
- "responses" : {
- "2XX" : {
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37910,17 +47225,18 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/timeline-event/",
- "tags" : [ "/api/timeline-event" ]
+ "summary" : "GET /api/transform/run",
+ "tags" : [ "/api/transform" ]
}
},
- "/api/timeline-event/{id}" : {
- "delete" : {
- "description" : "Delete a [[TimelineEvent]].",
+ "/api/transform/run/{run-id}" : {
+ "get" : {
+ "description" : "Get a transform run by ID.",
+ "operationId" : "get-api-transform-run-run-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "id",
+ "name" : "run-id",
"required" : true,
"schema" : {
"minimum" : 1,
@@ -37929,6 +47245,121 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ],
+ "type" : "string"
+ },
+ "transform" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "collection" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "deleted" : {
+ "type" : "boolean"
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ }
+ },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37938,11 +47369,14 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/timeline-event/{id}",
- "tags" : [ "/api/timeline-event" ]
- },
- "get" : {
- "description" : "Fetch the [[TimelineEvent]] with `id`.",
+ "summary" : "GET /api/transform/run/{run-id}",
+ "tags" : [ "/api/transform" ]
+ }
+ },
+ "/api/transform/{id}" : {
+ "delete" : {
+ "description" : "Delete a transform.",
+ "operationId" : "delete-api-transform-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -37955,6 +47389,13 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -37964,11 +47405,12 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/timeline-event/{id}",
- "tags" : [ "/api/timeline-event" ]
+ "summary" : "DELETE /api/transform/{id}",
+ "tags" : [ "/api/transform" ]
},
- "put" : {
- "description" : "Update a [[TimelineEvent]].",
+ "get" : {
+ "description" : "Get a specific transform.",
+ "operationId" : "get-api-transform-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -37979,121 +47421,281 @@
"type" : "integer"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "icon" : {
- "oneOf" : [ {
- "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "time_matters" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "timeline_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "timestamp" : {
- "oneOf" : [ {
- "description" : "value must be a valid date string",
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "timezone" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "PUT /api/timeline-event/{id}",
- "tags" : [ "/api/timeline-event" ]
- }
- },
- "/api/timeline/" : {
- "get" : {
- "description" : "Fetch a list of `Timeline`s. Can include `archived=true` to return archived timelines.",
- "parameters" : [ {
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.timeline.api.timeline.include"
- }
- }, {
- "in" : "query",
- "name" : "archived",
- "required" : true,
- "schema" : {
- "default" : false,
- "type" : "boolean"
- }
- } ],
"responses" : {
"2XX" : {
"content" : {
"application/json" : {
"schema" : {
- "items" : {
- "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
+ "additionalProperties" : false,
+ "properties" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "creator" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : { },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "is_qbnewb" : {
+ "type" : "boolean"
+ },
+ "is_superuser" : {
+ "type" : "boolean"
+ },
+ "last_login" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tenant_id" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name" ],
+ "type" : "object"
+ },
+ "creator_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "dependency_analysis_version" : {
+ "type" : "integer"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ],
+ "type" : "string"
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "email" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : { },
+ "source_database_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_readable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_type" : {
+ "type" : "string"
+ },
+ "table" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "target" : { },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : { }
},
- "type" : "array"
+ "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
+ "type" : "object"
}
}
},
@@ -38106,24 +47708,27 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/timeline/",
- "tags" : [ "/api/timeline" ]
+ "summary" : "GET /api/transform/{id}",
+ "tags" : [ "/api/transform" ]
},
- "post" : {
- "description" : "Create a new [[Timeline]].",
- "parameters" : [ ],
+ "put" : {
+ "description" : "Update a transform.",
+ "operationId" : "put-api-transform-id",
+ "parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "minimum" : 1,
+ "type" : "integer"
+ }
+ } ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
"collection_id" : {
"oneOf" : [ {
"description" : "value must be an integer greater than zero.",
@@ -38133,34 +47738,50 @@
"type" : "null"
} ]
},
- "default" : {
+ "description" : {
"oneOf" : [ {
- "type" : "boolean"
+ "type" : "string"
}, {
"type" : "null"
} ]
},
- "description" : {
+ "name" : {
+ "type" : "string"
+ },
+ "owner_email" : {
"oneOf" : [ {
"type" : "string"
}, {
"type" : "null"
} ]
},
- "icon" : {
+ "owner_user_id" : {
"oneOf" : [ {
- "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ],
- "type" : "string"
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "name" : {
- "minLength" : 1,
- "type" : "string"
+ "run_trigger" : {
+ "$ref" : "#/components/schemas/metabase.transforms-rest.api.transform.run-trigger"
+ },
+ "source" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-source"
+ },
+ "tag_ids" : {
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "target" : {
+ "$ref" : "#/components/schemas/metabase.transforms.schema.transform-target"
}
},
- "required" : [ "name" ],
"type" : "object"
}
}
@@ -38171,7 +47792,276 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
+ "additionalProperties" : false,
+ "properties" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "creator" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : { },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "is_qbnewb" : {
+ "type" : "boolean"
+ },
+ "is_superuser" : {
+ "type" : "boolean"
+ },
+ "last_login" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tenant_id" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name" ],
+ "type" : "object"
+ },
+ "creator_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "dependency_analysis_version" : {
+ "type" : "integer"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ],
+ "type" : "string"
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "email" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : { },
+ "source_database_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_readable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_type" : {
+ "type" : "string"
+ },
+ "table" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "target" : { },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
+ "type" : "object"
}
}
},
@@ -38184,39 +48074,33 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/timeline/",
- "tags" : [ "/api/timeline" ]
+ "summary" : "PUT /api/transform/{id}",
+ "tags" : [ "/api/transform" ]
}
},
- "/api/timeline/collection/root" : {
- "get" : {
- "description" : "Fetch the root Collection's timelines.",
+ "/api/transform/{id}/cancel" : {
+ "post" : {
+ "description" : "Cancel the current run for a given transform.",
+ "operationId" : "post-api-transform-id-cancel",
"parameters" : [ {
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "const" : "events"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "archived",
+ "description" : "value must be an integer greater than zero.",
+ "in" : "path",
+ "name" : "id",
"required" : true,
"schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -38226,13 +48110,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/timeline/collection/root",
- "tags" : [ "/api/timeline" ]
+ "summary" : "POST /api/transform/{id}/cancel",
+ "tags" : [ "/api/transform" ]
}
},
- "/api/timeline/collection/{id}" : {
+ "/api/transform/{id}/dependencies" : {
"get" : {
- "description" : "Fetch a specific Collection's timelines.",
+ "description" : "Get the dependencies of a specific transform.",
+ "operationId" : "get-api-transform-id-dependencies",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -38242,32 +48127,288 @@
"minimum" : 1,
"type" : "integer"
}
- }, {
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "oneOf" : [ {
- "const" : "events"
- }, {
- "type" : "null"
- } ]
- }
- }, {
- "in" : "query",
- "name" : "archived",
- "required" : true,
- "schema" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "collection_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "created_at" : { },
+ "creator" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "date_joined" : { },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_data_analyst" : {
+ "type" : "boolean"
+ },
+ "is_qbnewb" : {
+ "type" : "boolean"
+ },
+ "is_superuser" : {
+ "type" : "boolean"
+ },
+ "last_login" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tenant_id" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "email", "first_name", "last_name" ],
+ "type" : "object"
+ },
+ "creator_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "dependency_analysis_version" : {
+ "type" : "integer"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_run" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "end_time" : {
+ "oneOf" : [ { }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_method" : {
+ "type" : "string"
+ },
+ "start_time" : { },
+ "status" : {
+ "enum" : [ "started", "succeeded", "failed", "timeout", "canceled", "canceling" ],
+ "type" : "string"
+ },
+ "transform_entity_id" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "transform_id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "transform_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "transform_id", "run_method", "status", "is_active", "start_time", "message", "user_id" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "owner" : {
+ "oneOf" : [ {
+ "additionalProperties" : false,
+ "properties" : {
+ "common_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "email" : {
+ "type" : "string"
+ },
+ "first_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "last_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "email" ],
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_email" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "owner_user_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "run_trigger" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source" : { },
+ "source_database_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_readable" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "source_type" : {
+ "type" : "string"
+ },
+ "table" : {
+ "oneOf" : [ {
+ "properties" : { },
+ "type" : "object"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "tag_ids" : {
+ "items" : {
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "type" : "array"
+ },
+ "target" : { },
+ "target_db_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "updated_at" : { }
+ },
+ "required" : [ "id", "name", "description", "source", "target", "source_type", "entity_id", "created_at", "updated_at", "creator_id", "collection_id", "dependency_analysis_version", "creator" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -38276,14 +48417,15 @@
"5XX" : {
"description" : "Server error response"
}
- },
- "summary" : "GET /api/timeline/collection/{id}",
- "tags" : [ "/api/timeline" ]
+ },
+ "summary" : "GET /api/transform/{id}/dependencies",
+ "tags" : [ "/api/transform" ]
}
},
- "/api/timeline/{id}" : {
- "delete" : {
- "description" : "Delete a [[Timeline]]. Will cascade delete its events as well.",
+ "/api/transform/{id}/inspect" : {
+ "get" : {
+ "description" : "Phase 1: Discover available lenses for a transform.\n Returns structural metadata and available lens types.",
+ "operationId" : "get-api-transform-id-inspect",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -38296,6 +48438,13 @@
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.discovery-response"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -38305,11 +48454,14 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/timeline/{id}",
- "tags" : [ "/api/timeline" ]
- },
+ "summary" : "GET /api/transform/{id}/inspect",
+ "tags" : [ "/api/transform" ]
+ }
+ },
+ "/api/transform/{id}/inspect/{lens-id}" : {
"get" : {
- "description" : "Fetch the `Timeline` with `id`. Include `include=events` to unarchived events included on the timeline. Add\n `archived=true` to return all events on the timeline, both archived and unarchived.",
+ "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.",
+ "operationId" : "get-api-transform-id-inspect-lens-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -38320,34 +48472,11 @@
"type" : "integer"
}
}, {
- "in" : "query",
- "name" : "include",
- "required" : false,
- "schema" : {
- "$ref" : "#/components/schemas/metabase.timeline.api.timeline.include"
- }
- }, {
- "in" : "query",
- "name" : "archived",
+ "in" : "path",
+ "name" : "lens-id",
"required" : true,
"schema" : {
- "default" : "false",
- "type" : "boolean"
- }
- }, {
- "description" : "value must be a valid date string",
- "in" : "query",
- "name" : "start",
- "required" : false,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "value must be a valid date string",
- "in" : "query",
- "name" : "end",
- "required" : false,
- "schema" : {
+ "minLength" : 1,
"type" : "string"
}
} ],
@@ -38356,7 +48485,7 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.timeline.api.timeline.Timeline"
+ "$ref" : "#/components/schemas/metabase.transforms-inspector.schema.lens"
}
}
},
@@ -38369,11 +48498,14 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/timeline/{id}",
- "tags" : [ "/api/timeline" ]
- },
- "put" : {
- "description" : "Update the [[Timeline]] with `id`. Returns the timeline without events. Archiving a timeline will archive all of the\n events in that timeline.",
+ "summary" : "GET /api/transform/{id}/inspect/{lens-id}",
+ "tags" : [ "/api/transform" ]
+ }
+ },
+ "/api/transform/{id}/inspect/{lens-id}/query" : {
+ "post" : {
+ "description" : "Execute a query in the context of a transform inspector lens.",
+ "operationId" : "post-api-transform-id-inspect-lens-id-query",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -38383,108 +48515,42 @@
"minimum" : 1,
"type" : "integer"
}
+ }, {
+ "in" : "path",
+ "name" : "lens-id",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"properties" : {
- "archived" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "collection_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "minimum" : 1,
- "type" : "integer"
- }, {
- "type" : "null"
- } ]
- },
- "default" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "description" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "icon" : {
- "oneOf" : [ {
- "enum" : [ "star", "cake", "mail", "warning", "bell", "cloud" ],
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "name" : {
- "oneOf" : [ {
- "minLength" : 1,
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- }
- },
- "type" : "object"
- }
- }
- }
- },
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "summary" : "PUT /api/timeline/{id}",
- "tags" : [ "/api/timeline" ]
- }
- },
- "/api/upload/csv" : {
- "post" : {
- "description" : "Create a table and model populated with the values from the attached CSV. Returns the model ID if successful.",
- "parameters" : [ ],
- "requestBody" : {
- "content" : {
- "multipart/form-data" : {
- "schema" : {
- "properties" : {
- "collection_id" : {
+ "lens_params" : {
"oneOf" : [ {
- "minimum" : 1,
- "type" : "integer"
+ "additionalProperties" : { },
+ "type" : "object"
}, {
"type" : "null"
} ]
},
- "file" : {
+ "query" : {
"properties" : {
- "filename" : {
- "type" : "string"
- },
- "tempfile" : { }
+ "database" : {
+ "oneOf" : [ {
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
},
- "required" : [ "filename", "tempfile" ],
"type" : "object"
}
},
- "required" : [ "collection_id", "file" ],
+ "required" : [ "query" ],
"type" : "object"
}
}
@@ -38492,6 +48558,13 @@
},
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.query-processor.schema.query-result"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -38501,24 +48574,70 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/upload/csv",
- "tags" : [ "/api/upload" ]
+ "summary" : "POST /api/transform/{id}/inspect/{lens-id}/query",
+ "tags" : [ "/api/transform" ]
}
},
- "/api/user-key-value/namespace/{namespace}" : {
+ "/api/transform/{id}/merge-history" : {
"get" : {
- "description" : "Returns all KV pairs in a given namespace for the current user",
+ "description" : "Get merge history for a transform. Returns all merge events that affected this transform,\n ordered by created_at descending (newest first).",
+ "operationId" : "get-api-transform-id-merge-history",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "namespace",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "items" : {
+ "properties" : {
+ "commit_message" : {
+ "type" : "string"
+ },
+ "created_at" : { },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "merging_user_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "workspace_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "workspace_merge_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "minimum" : 1,
+ "type" : "integer"
+ },
+ "workspace_name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "workspace_merge_id", "commit_message", "workspace_id", "workspace_name", "merging_user_id", "created_at" ],
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -38528,32 +48647,55 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/user-key-value/namespace/{namespace}",
- "tags" : [ "/api/user-key-value" ]
+ "summary" : "GET /api/transform/{id}/merge-history",
+ "tags" : [ "/api/transform" ]
}
},
- "/api/user-key-value/namespace/{namespace}/key/{key}" : {
- "delete" : {
- "description" : "Deletes a KV-pair for the user",
+ "/api/transform/{id}/run" : {
+ "post" : {
+ "description" : "Run a transform.",
+ "operationId" : "post-api-transform-id-run",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "namespace",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "body" : {
+ "additionalProperties" : false,
+ "properties" : {
+ "message" : { },
+ "run_id" : {
+ "oneOf" : [ {
+ "minimum" : 1,
+ "type" : "integer"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "message", "run_id" ],
+ "type" : "object"
+ },
+ "status" : {
+ "const" : 202
+ }
+ },
+ "required" : [ "status", "body" ],
+ "type" : "object"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -38563,30 +48705,33 @@
"description" : "Server error response"
}
},
- "summary" : "DELETE /api/user-key-value/namespace/{namespace}/key/{key}",
- "tags" : [ "/api/user-key-value" ]
- },
- "get" : {
- "description" : "Get a value for the user",
+ "summary" : "POST /api/transform/{id}/run",
+ "tags" : [ "/api/transform" ]
+ }
+ },
+ "/api/transform/{id}/table" : {
+ "delete" : {
+ "description" : "Delete a transform's output table.",
+ "operationId" : "delete-api-transform-id-table",
"parameters" : [ {
+ "description" : "value must be an integer greater than zero.",
"in" : "path",
- "name" : "key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "namespace",
+ "name" : "id",
"required" : true,
"schema" : {
- "minLength" : 1,
- "type" : "string"
+ "minimum" : 1,
+ "type" : "integer"
}
} ],
"responses" : {
"2XX" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ },
"description" : "Successful response"
},
"4XX" : {
@@ -38596,42 +48741,40 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/user-key-value/namespace/{namespace}/key/{key}",
- "tags" : [ "/api/user-key-value" ]
- },
- "put" : {
- "description" : "Upsert a KV-pair for the user",
- "parameters" : [ {
- "in" : "path",
- "name" : "key",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "namespace",
- "required" : true,
- "schema" : {
- "minLength" : 1,
- "type" : "string"
- }
- } ],
+ "summary" : "DELETE /api/transform/{id}/table",
+ "tags" : [ "/api/transform" ]
+ }
+ },
+ "/api/upload/csv" : {
+ "post" : {
+ "description" : "Create a table and model populated with the values from the attached CSV. Returns the model ID if successful.",
+ "operationId" : "post-api-upload-csv",
+ "parameters" : [ ],
"requestBody" : {
"content" : {
- "application/json" : {
+ "multipart/form-data" : {
"schema" : {
"properties" : {
- "expires_at" : {
+ "collection_id" : {
"oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
+ "minimum" : 1,
+ "type" : "integer"
}, {
"type" : "null"
} ]
},
- "value" : { }
+ "file" : {
+ "properties" : {
+ "filename" : {
+ "type" : "string"
+ },
+ "tempfile" : { }
+ },
+ "required" : [ "filename", "tempfile" ],
+ "type" : "object"
+ }
},
+ "required" : [ "collection_id", "file" ],
"type" : "object"
}
}
@@ -38648,13 +48791,14 @@
"description" : "Server error response"
}
},
- "summary" : "PUT /api/user-key-value/namespace/{namespace}/key/{key}",
- "tags" : [ "/api/user-key-value" ]
+ "summary" : "POST /api/upload/csv",
+ "tags" : [ "/api/upload" ]
}
},
- "/api/user/" : {
+ "/api/user" : {
"get" : {
- "description" : "Fetch a list of `Users` for admins or group managers.\n By default returns only active users for admins and only active users within groups that the group manager is\n managing for group managers.\n\n - If `status` is `deactivated`, include deactivated users only.\n\n - If `status` is `all`, include all users (active and inactive).\n\n - Also supports `include_deactivated`, which if true, is equivalent to `status=all`; If is false, is equivalent to\n `status=active`. `status` and `include_deactivated` requires superuser permissions.\n\n - `include_deactivated` is a legacy alias for `status` and will be removed in a future release, users are advised\n to use `status` for better support and flexibility.\n\n If both params are passed, `status` takes precedence.\n - if a `tenant_id` is passed, only users with that tenant_id will be returned.\n\n For users with segmented permissions, return only themselves.\n\n Takes `limit`, `offset` for pagination.\n\n Takes `query` for filtering on first name, last name, email.\n\n Also takes `group_id`, which filters on group id.",
+ "description" : "Fetch a list of `Users` for admins or group managers.\n By default returns only active users for admins/data-analysts and only active users within groups that the group manager is\n managing for group managers.\n\n - If `status` is `deactivated`, include deactivated users only.\n\n - If `status` is `all`, include all users (active and inactive).\n\n - Also supports `include_deactivated`, which if true, is equivalent to `status=all`; If is false, is equivalent to\n `status=active`. `status` and `include_deactivated` requires superuser permissions.\n\n - `include_deactivated` is a legacy alias for `status` and will be removed in a future release, users are advised\n to use `status` for better support and flexibility.\n\n If both params are passed, `status` takes precedence.\n - if a `tenant_id` is passed, only users with that tenant_id will be returned.\n\n For users with segmented permissions, return only themselves.\n\n Takes `limit`, `offset` for pagination.\n\n Takes `query` for filtering on first name, last name, email.\n\n Also takes `group_id`, which filters on group id.\n\n If the user is a sandboxed user, only return themselves regardless of the query parameters.",
+ "operationId" : "get-api-user",
"parameters" : [ {
"in" : "query",
"name" : "status",
@@ -38702,6 +48846,28 @@
"type" : "null"
} ]
}
+ }, {
+ "in" : "query",
+ "name" : "is_data_analyst",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "can_access_data_studio",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ }
}, {
"in" : "query",
"name" : "tenancy",
@@ -38739,11 +48905,12 @@
"description" : "Server error response"
}
},
- "summary" : "GET /api/user/",
+ "summary" : "GET /api/user",
"tags" : [ "/api/user" ]
},
"post" : {
"description" : "Create a new `User`, return a 400 if the email address is already taken",
+ "operationId" : "post-api-user",
"parameters" : [ ],
"requestBody" : {
"content" : {
@@ -38781,7 +48948,6 @@
"source" : {
"default" : "admin",
"oneOf" : [ {
- "minLength" : 1,
"type" : "string"
}, {
"type" : "null"
@@ -38799,7 +48965,7 @@
"user_group_memberships" : {
"oneOf" : [ {
"items" : {
- "$ref" : "#/components/schemas/metabase.users-rest.api.user-group-membership"
+ "$ref" : "#/components/schemas/metabase.users.schema.user-group-membership"
},
"type" : "array"
}, {
@@ -38824,13 +48990,165 @@
"description" : "Server error response"
}
},
- "summary" : "POST /api/user/",
+ "summary" : "POST /api/user",
"tags" : [ "/api/user" ]
}
},
+ "/api/user-key-value/namespace/{namespace}" : {
+ "get" : {
+ "description" : "Returns all KV pairs in a given namespace for the current user",
+ "operationId" : "get-api-user-key-value-namespace-namespace",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "namespace",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/user-key-value/namespace/{namespace}",
+ "tags" : [ "/api/user-key-value" ]
+ }
+ },
+ "/api/user-key-value/namespace/{namespace}/key/{key}" : {
+ "delete" : {
+ "description" : "Deletes a KV-pair for the user",
+ "operationId" : "delete-api-user-key-value-namespace-namespace-key-key",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "namespace",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "DELETE /api/user-key-value/namespace/{namespace}/key/{key}",
+ "tags" : [ "/api/user-key-value" ]
+ },
+ "get" : {
+ "description" : "Get a value for the user",
+ "operationId" : "get-api-user-key-value-namespace-namespace-key-key",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "namespace",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "GET /api/user-key-value/namespace/{namespace}/key/{key}",
+ "tags" : [ "/api/user-key-value" ]
+ },
+ "put" : {
+ "description" : "Upsert a KV-pair for the user",
+ "operationId" : "put-api-user-key-value-namespace-namespace-key-key",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "key",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "namespace",
+ "required" : true,
+ "schema" : {
+ "minLength" : 1,
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "properties" : {
+ "expires_at" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.literal..string.datetime"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "value" : { }
+ },
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "summary" : "PUT /api/user-key-value/namespace/{namespace}/key/{key}",
+ "tags" : [ "/api/user-key-value" ]
+ }
+ },
"/api/user/current" : {
"get" : {
"description" : "Fetch the current `User`.",
+ "operationId" : "get-api-user-current",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -38850,6 +49168,7 @@
"/api/user/recipients" : {
"get" : {
"description" : "Fetch a list of `Users`. Returns only active users. Meant for non-admins unlike GET /api/user.\n\n - If user-visibility is :all or the user is an admin, include all users.\n - If user-visibility is :group, include only users in the same group (excluding the all users group).\n - If user-visibility is :none or the user is sandboxed, include only themselves.",
+ "operationId" : "get-api-user-recipients",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -38869,6 +49188,7 @@
"/api/user/{id}" : {
"delete" : {
"description" : "Disable a `User`. This does not remove the `User` from the DB, but instead disables their account.",
+ "operationId" : "delete-api-user-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -38895,6 +49215,7 @@
},
"get" : {
"description" : "Fetch a `User`. You must be fetching yourself *or* be a superuser *or* a Group Manager.",
+ "operationId" : "get-api-user-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -38921,6 +49242,7 @@
},
"put" : {
"description" : "Update an existing, active `User`.\n Self or superusers can update user info and groups.\n Group Managers can only add/remove users from groups they are manager of.",
+ "operationId" : "put-api-user-id",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -38952,6 +49274,13 @@
"type" : "null"
} ]
},
+ "is_data_analyst" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
"is_group_manager" : {
"oneOf" : [ {
"type" : "boolean"
@@ -39003,7 +49332,7 @@
"user_group_memberships" : {
"oneOf" : [ {
"items" : {
- "$ref" : "#/components/schemas/metabase.users-rest.api.user-group-membership"
+ "$ref" : "#/components/schemas/metabase.users.schema.user-group-membership"
},
"type" : "array"
}, {
@@ -39034,6 +49363,7 @@
"/api/user/{id}/modal/{modal}" : {
"put" : {
"description" : "Indicate that a user has been informed about the vast intricacies of 'the' Query Builder.",
+ "operationId" : "put-api-user-id-modal-modal",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -39070,6 +49400,7 @@
"/api/user/{id}/password" : {
"put" : {
"description" : "Update a user's password.",
+ "operationId" : "put-api-user-id-password",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -39114,6 +49445,7 @@
"/api/user/{id}/reactivate" : {
"put" : {
"description" : "Reactivate user at `:id`",
+ "operationId" : "put-api-user-id-reactivate",
"parameters" : [ {
"description" : "value must be an integer greater than zero.",
"in" : "path",
@@ -39142,6 +49474,7 @@
"/api/util/random_token" : {
"get" : {
"description" : "Return a cryptographically secure random 32-byte token, encoded as a hexadecimal string.\n Intended for use when creating a value for `embedding-secret-key`.",
+ "operationId" : "get-api-util-random_token",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -39159,6 +49492,9 @@
}
}
},
+ "security" : [ {
+ "ApiKeyAuth" : [ ]
+ } ],
"servers" : [ {
"description" : "Metabase API",
"url" : ""