Skip to content

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

Auto-update documentation for master (#76764)

github-automation-metabase34cc99da9a53
diff --git a/docs/api.json b/docs/api.json
index 7f004e7ce49..6037817d077 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -19539,408 +19539,6 @@
"tags" : [ "/api/comment" ]
}
},
- "/api/curated-search" : {
- "get" : {
- "operationId" : "get-api-curated-search",
- "summary" : "GET /api/curated-search",
- "description" : "Get all curated search entries, paginated.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "entity" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "integer"
- },
- "model" : {
- "type" : "string"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "model", "id" ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "search_prompt" : {
- "type" : "string"
- },
- "usage_instructions" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "verified" : {
- "type" : "boolean"
- }
- },
- "required" : [ "id", "search_prompt", "entity", "verified" ]
- }
- },
- "limit" : {
- "type" : "integer"
- },
- "offset" : {
- "type" : "integer"
- },
- "total" : {
- "type" : "integer"
- }
- },
- "required" : [ "data", "total", "limit", "offset" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/curated-search" ]
- },
- "post" : {
- "operationId" : "post-api-curated-search",
- "summary" : "POST /api/curated-search",
- "description" : "Create a new curated search entry.",
- "parameters" : [ ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "entity" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "integer"
- },
- "model" : {
- "type" : "string"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "model", "id" ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "search_prompt" : {
- "type" : "string"
- },
- "usage_instructions" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "verified" : {
- "type" : "boolean"
- }
- },
- "required" : [ "id", "search_prompt", "entity", "verified" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "entity" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "model" : {
- "type" : "string",
- "enum" : [ "table", "card", "model", "metric", "question" ]
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "model", "id" ]
- },
- "search_prompt" : {
- "type" : "string",
- "minLength" : 1
- },
- "usage_instructions" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "verified" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ "search_prompt", "entity" ]
- }
- }
- }
- },
- "tags" : [ "/api/curated-search" ]
- }
- },
- "/api/curated-search/{id}" : {
- "get" : {
- "operationId" : "get-api-curated-search-id",
- "summary" : "GET /api/curated-search/{id}",
- "description" : "Get a curated search entry by ID.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "entity" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "integer"
- },
- "model" : {
- "type" : "string"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "model", "id" ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "search_prompt" : {
- "type" : "string"
- },
- "usage_instructions" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "verified" : {
- "type" : "boolean"
- }
- },
- "required" : [ "id", "search_prompt", "entity", "verified" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/curated-search" ]
- },
- "put" : {
- "operationId" : "put-api-curated-search-id",
- "summary" : "PUT /api/curated-search/{id}",
- "description" : "Update a curated search entry by ID. Only the provided fields are changed; sending a null\n usage_instructions clears it.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "entity" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "type" : "integer"
- },
- "model" : {
- "type" : "string"
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "model", "id" ]
- },
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "search_prompt" : {
- "type" : "string"
- },
- "usage_instructions" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "verified" : {
- "type" : "boolean"
- }
- },
- "required" : [ "id", "search_prompt", "entity", "verified" ]
- }
- }
- }
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "entity" : {
- "type" : "object",
- "properties" : {
- "id" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "model" : {
- "type" : "string",
- "enum" : [ "table", "card", "model", "metric", "question" ]
- },
- "name" : {
- "type" : "string"
- }
- },
- "required" : [ "model", "id" ]
- },
- "search_prompt" : {
- "type" : "string",
- "minLength" : 1
- },
- "usage_instructions" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "verified" : {
- "type" : "boolean"
- }
- }
- }
- }
- }
- },
- "tags" : [ "/api/curated-search" ]
- },
- "delete" : {
- "operationId" : "delete-api-curated-search-id",
- "summary" : "DELETE /api/curated-search/{id}",
- "description" : "Delete a curated search entry by ID.",
- "parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
- "schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
- } ],
- "responses" : {
- "2XX" : {
- "description" : "Successful response"
- },
- "4XX" : {
- "description" : "Client error response"
- },
- "5XX" : {
- "description" : "Server error response"
- }
- },
- "tags" : [ "/api/curated-search" ]
- }
- },
"/api/dashboard" : {
"get" : {
"operationId" : "get-api-dashboard",
@@ -39075,12 +38673,182 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/notification" ]
- },
- "put" : {
- "operationId" : "put-api-notification-id",
- "summary" : "PUT /api/notification/{id}",
- "description" : "Update a notification, can also update its subscriptions, handlers.\n Return the updated notification.\n\n `creator_id` (owner) can be reassigned here only by superusers (e.g. the admin 'Edit alert'\n modal's owner picker). `mi/can-update?` rejects a non-superuser reassignment attempt with 403;\n the model's `before-update` hook is the backstop. Echoing back the unchanged value is fine.",
+ "tags" : [ "/api/notification" ]
+ },
+ "put" : {
+ "operationId" : "put-api-notification-id",
+ "summary" : "PUT /api/notification/{id}",
+ "description" : "Update a notification, can also update its subscriptions, handlers.\n Return the updated notification.\n\n `creator_id` (owner) can be reassigned here only by superusers (e.g. the admin 'Edit alert'\n modal's owner picker). `mi/can-update?` rejects a non-superuser reassignment attempt with 403;\n the model's `before-update` hook is the backstop. Echoing back the unchanged value is fine.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.notification.api.notification.NotificationApiInput"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/notification" ]
+ }
+ },
+ "/api/notification/{id}/send" : {
+ "post" : {
+ "operationId" : "post-api-notification-id-send",
+ "summary" : "POST /api/notification/{id}/send",
+ "description" : "Send a notification by id.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "handler_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/notification" ]
+ }
+ },
+ "/api/notification/{id}/unsubscribe" : {
+ "post" : {
+ "operationId" : "post-api-notification-id-unsubscribe",
+ "summary" : "POST /api/notification/{id}/unsubscribe",
+ "description" : "Unsubscribe current user from a notification.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/notification" ]
+ }
+ },
+ "/api/notify/db/attached_datawarehouse" : {
+ "post" : {
+ "operationId" : "post-api-notify-db-attached_datawarehouse",
+ "summary" : "POST /api/notify/db/attached_datawarehouse",
+ "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" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "schema_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "synchronous?" : {
+ "default" : false,
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/notify" ]
+ }
+ },
+ "/api/notify/db/{id}" : {
+ "post" : {
+ "operationId" : "post-api-notify-db-id",
+ "summary" : "POST /api/notify/db/{id}",
+ "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)",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -39106,19 +38874,46 @@
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/metabase.notification.api.notification.NotificationApiInput"
+ "type" : "object",
+ "properties" : {
+ "scan" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "full", "schema" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "table_name" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
}
}
}
},
- "tags" : [ "/api/notification" ]
+ "tags" : [ "/api/notify" ]
}
},
- "/api/notification/{id}/send" : {
+ "/api/notify/db/{id}/new-table" : {
"post" : {
- "operationId" : "post-api-notification-id-send",
- "summary" : "POST /api/notification/{id}/send",
- "description" : "Send a notification by id.",
+ "operationId" : "post-api-notify-db-id-new-table",
+ "summary" : "POST /api/notify/db/{id}/new-table",
+ "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.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -39146,40 +38941,88 @@
"schema" : {
"type" : "object",
"properties" : {
- "handler_ids" : {
- "type" : "array",
- "items" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }
+ "schema_name" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "table_name" : {
+ "type" : "string",
+ "minLength" : 1
}
- }
+ },
+ "required" : [ "schema_name", "table_name" ]
}
}
}
},
- "tags" : [ "/api/notification" ]
+ "tags" : [ "/api/notify" ]
}
},
- "/api/notification/{id}/unsubscribe" : {
- "post" : {
- "operationId" : "post-api-notification-id-unsubscribe",
- "summary" : "POST /api/notification/{id}/unsubscribe",
- "description" : "Unsubscribe current user from a notification.",
+ "/api/oauth/authorizations" : {
+ "get" : {
+ "operationId" : "get-api-oauth-authorizations",
+ "summary" : "GET /api/oauth/authorizations",
+ "description" : "List OAuth dynamic client registration events (registered, approved, or denied), newest first.\n Joins client info and, for decision events, the deciding user. Superuser only.",
"parameters" : [ {
- "in" : "path",
- "name" : "id",
- "required" : true,
+ "in" : "query",
+ "name" : "client-id",
+ "required" : false,
"schema" : {
- "type" : "integer",
- "minimum" : 1
- },
- "description" : "value must be an integer greater than zero."
+ "oneOf" : [ {
+ "type" : "string",
+ "minLength" : 1
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "event-type",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "registered", "approved", "denied" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ },
+ "limit" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "offset" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "total" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "total", "limit", "offset", "data" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -39188,18 +39031,81 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/notification" ]
+ "tags" : [ "/api/oauth" ]
}
},
- "/api/notify/db/attached_datawarehouse" : {
- "post" : {
- "operationId" : "post-api-notify-db-attached_datawarehouse",
- "summary" : "POST /api/notify/db/attached_datawarehouse",
- "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.",
+ "/api/osi/ai-context" : {
+ "get" : {
+ "operationId" : "get-api-osi-ai-context",
+ "summary" : "GET /api/osi/ai-context",
+ "description" : "Get all ai_context entries, paginated.",
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "ai_context" : {
+ "type" : "object",
+ "properties" : {
+ "examples" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "maxLength" : 1000
+ },
+ "maxItems" : 50
+ },
+ "instructions" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "maxLength" : 5000
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "synonyms" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "maxLength" : 1000
+ },
+ "maxItems" : 50
+ }
+ }
+ },
+ "entity_local_id" : {
+ "type" : "integer"
+ },
+ "entity_type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "entity_type", "entity_local_id", "ai_context" ]
+ }
+ },
+ "limit" : {
+ "type" : "integer"
+ },
+ "offset" : {
+ "type" : "integer"
+ },
+ "total" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "data", "total", "limit", "offset" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -39208,52 +39114,82 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "schema_name" : {
- "oneOf" : [ {
- "type" : "string"
- }, {
- "type" : "null"
- } ]
- },
- "synchronous?" : {
- "default" : false,
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "table_name" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
- },
- "required" : [ ]
+ "tags" : [ "/api/osi/ai-context" ]
+ }
+ },
+ "/api/osi/ai-context/reconcile" : {
+ "post" : {
+ "operationId" : "post-api-osi-ai-context-reconcile",
+ "summary" : "POST /api/osi/ai-context/reconcile",
+ "description" : "Force a reconcile of the library entity index against the application database, blocking until a\n reconcile covering this call finishes.\n Returns the index mutations (`index`) separately from execution timing (`execution`: how long the run\n waited to start, then how long it ran).\n This call never reuses a reconcile already in progress (it may have started before your latest change);\n it starts one if the index is idle, otherwise it queues a single follow-up that any other waiting calls\n share.\n Requires the semantic search feature; returns a 400 when it isn't configured.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "execution" : {
+ "type" : "object",
+ "properties" : {
+ "ran_ms" : {
+ "type" : "integer"
+ },
+ "waited_ms" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "waited_ms", "ran_ms" ]
+ },
+ "index" : {
+ "type" : "object",
+ "properties" : {
+ "deleted" : {
+ "type" : "integer"
+ },
+ "inserted" : {
+ "type" : "integer"
+ },
+ "unchanged" : {
+ "type" : "integer"
+ }
+ },
+ "required" : [ "inserted", "deleted", "unchanged" ]
+ }
+ },
+ "required" : [ "index", "execution" ]
+ }
}
}
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
}
},
- "tags" : [ "/api/notify" ]
+ "tags" : [ "/api/osi/ai-context" ]
}
},
- "/api/notify/db/{id}" : {
- "post" : {
- "operationId" : "post-api-notify-db-id",
- "summary" : "POST /api/notify/db/{id}",
- "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/osi/ai-context/{entity-type}/{entity-local-id}" : {
+ "get" : {
+ "operationId" : "get-api-osi-ai-context-entity-type-entity-local-id",
+ "summary" : "GET /api/osi/ai-context/{entity-type}/{entity-local-id}",
+ "description" : "Get the ai_context entry for an entity by its logical `(entity_type, entity_local_id)` key.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "entity-type",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-local-id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -39263,7 +39199,52 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "ai_context" : {
+ "type" : "object",
+ "properties" : {
+ "examples" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "maxLength" : 1000
+ },
+ "maxItems" : 50
+ },
+ "instructions" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "maxLength" : 5000
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "synonyms" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "maxLength" : 1000
+ },
+ "maxItems" : 50
+ }
+ }
+ },
+ "entity_local_id" : {
+ "type" : "integer"
+ },
+ "entity_type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "entity_type", "entity_local_id", "ai_context" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -39272,53 +39253,23 @@
"description" : "Server error response"
}
},
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "scan" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "full", "schema" ]
- }, {
- "type" : "null"
- } ]
- },
- "table_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "table_name" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
- }
- }
- }
- }
- }
- },
- "tags" : [ "/api/notify" ]
- }
- },
- "/api/notify/db/{id}/new-table" : {
- "post" : {
- "operationId" : "post-api-notify-db-id-new-table",
- "summary" : "POST /api/notify/db/{id}/new-table",
- "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.",
+ "tags" : [ "/api/osi/ai-context" ]
+ },
+ "put" : {
+ "operationId" : "put-api-osi-ai-context-entity-type-entity-local-id",
+ "summary" : "PUT /api/osi/ai-context/{entity-type}/{entity-local-id}",
+ "description" : "Create or replace (upsert) the ai_context for an entity, addressed by its logical key. One row per\n entity: an existing row is updated in place rather than duplicated, and the compound primary key plus the\n upsert keep two concurrent writers from racing in a duplicate row.",
"parameters" : [ {
"in" : "path",
- "name" : "id",
+ "name" : "entity-type",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ }, {
+ "in" : "path",
+ "name" : "entity-local-id",
"required" : true,
"schema" : {
"type" : "integer",
@@ -39328,7 +39279,52 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "ai_context" : {
+ "type" : "object",
+ "properties" : {
+ "examples" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "maxLength" : 1000
+ },
+ "maxItems" : 50
+ },
+ "instructions" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "maxLength" : 5000
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "synonyms" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "maxLength" : 1000
+ },
+ "maxItems" : 50
+ }
+ }
+ },
+ "entity_local_id" : {
+ "type" : "integer"
+ },
+ "entity_type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "entity_type", "entity_local_id", "ai_context" ]
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -39343,88 +39339,68 @@
"schema" : {
"type" : "object",
"properties" : {
- "schema_name" : {
- "type" : "string",
- "minLength" : 1
- },
- "table_name" : {
- "type" : "string",
- "minLength" : 1
+ "ai_context" : {
+ "type" : "object",
+ "properties" : {
+ "examples" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "maxLength" : 1000
+ },
+ "maxItems" : 50
+ },
+ "instructions" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "maxLength" : 5000
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "synonyms" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string",
+ "maxLength" : 1000
+ },
+ "maxItems" : 50
+ }
+ }
}
},
- "required" : [ "schema_name", "table_name" ]
+ "required" : [ "ai_context" ]
}
}
}
},
- "tags" : [ "/api/notify" ]
- }
- },
- "/api/oauth/authorizations" : {
- "get" : {
- "operationId" : "get-api-oauth-authorizations",
- "summary" : "GET /api/oauth/authorizations",
- "description" : "List OAuth dynamic client registration events (registered, approved, or denied), newest first.\n Joins client info and, for decision events, the deciding user. Superuser only.",
+ "tags" : [ "/api/osi/ai-context" ]
+ },
+ "delete" : {
+ "operationId" : "delete-api-osi-ai-context-entity-type-entity-local-id",
+ "summary" : "DELETE /api/osi/ai-context/{entity-type}/{entity-local-id}",
+ "description" : "Delete the ai_context entry for an entity by its logical key.",
"parameters" : [ {
- "in" : "query",
- "name" : "client-id",
- "required" : false,
+ "in" : "path",
+ "name" : "entity-type",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "string",
- "minLength" : 1
- }, {
- "type" : "null"
- } ]
+ "type" : "string",
+ "minLength" : 1
}
}, {
- "in" : "query",
- "name" : "event-type",
- "required" : false,
+ "in" : "path",
+ "name" : "entity-local-id",
+ "required" : true,
"schema" : {
- "oneOf" : [ {
- "type" : "string",
- "enum" : [ "registered", "approved", "denied" ]
- }, {
- "type" : "null"
- } ]
- }
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response",
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "data" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : { }
- }
- },
- "limit" : {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- },
- "offset" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
- },
- "total" : {
- "description" : "value must be an integer greater or equal to than zero.",
- "type" : "integer",
- "minimum" : 0
- }
- },
- "required" : [ "total", "limit", "offset", "data" ]
- }
- }
- }
+ "description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
@@ -39433,7 +39409,7 @@
"description" : "Server error response"
}
},
- "tags" : [ "/api/oauth" ]
+ "tags" : [ "/api/osi/ai-context" ]
}
},
"/api/permissions/graph" : {