The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Auto-update documentation for master (#75289)
github-automation-metabase6db984ab33d4
diff --git a/docs/api.json b/docs/api.jsonindex 20cc90352b0..c508355361b 100644--- a/docs/api.json+++ b/docs/api.json@@ -2203,260 +2203,6 @@},"required" : [ "nodes", "edges" ]},- "metabase-enterprise.notification-admin.api.bulk-response" : {- "type" : "object",- "properties" : {- "updated" : {- "description" : "value must be an integer greater or equal to than zero.",- "type" : "integer",- "minimum" : 0- }- },- "required" : [ "updated" ]- },- "metabase-enterprise.notification-admin.api.channel-entry" : {- "description" : "One channel delivery attempt within a tick.",- "type" : "object",- "properties" : {- "channel_type" : {- "type" : "string"- },- "error" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "status" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.run-status"- }- },- "required" : [ "channel_type", "status", "error" ],- "additionalProperties" : false- },- "metabase-enterprise.notification-admin.api.detail-response" : {- "type" : "object",- "properties" : {- "last_check" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.run-summary"- }, {- "type" : "null"- } ]- },- "payload_type" : {- "type" : "string"- },- "payload_id" : {- "oneOf" : [ {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }, {- "type" : "null"- } ]- },- "send_history" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.tick-send-entry"- }- },- "id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "check_history" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.run-summary"- }- },- "last_send" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.run-summary"- }, {- "type" : "null"- } ]- },- "updated_at" : {- "type" : "string",- "format" : "date-time"- },- "created_at" : {- "type" : "string",- "format" : "date-time"- },- "active" : {- "type" : "boolean"- },- "creator_id" : {- "oneOf" : [ {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }, {- "type" : "null"- } ]- }- },- "required" : [ "id", "active", "creator_id", "created_at", "updated_at", "payload_type", "payload_id", "last_check", "last_send", "check_history", "send_history" ]- },- "metabase-enterprise.notification-admin.api.list-response" : {- "type" : "object",- "properties" : {- "data" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.list-row"- }- },- "limit" : {- "oneOf" : [ {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }, {- "type" : "null"- } ]- },- "offset" : {- "oneOf" : [ {- "description" : "value must be an integer greater or equal to than zero.",- "type" : "integer",- "minimum" : 0- }, {- "type" : "null"- } ]- },- "total" : {- "description" : "value must be an integer greater or equal to than zero.",- "type" : "integer",- "minimum" : 0- }- },- "required" : [ "data", "total", "limit", "offset" ]- },- "metabase-enterprise.notification-admin.api.list-row" : {- "type" : "object",- "properties" : {- "last_check" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.run-summary"- }, {- "type" : "null"- } ]- },- "payload_type" : {- "type" : "string"- },- "payload_id" : {- "oneOf" : [ {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }, {- "type" : "null"- } ]- },- "id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "last_send" : {- "oneOf" : [ {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.run-summary"- }, {- "type" : "null"- } ]- },- "updated_at" : {- "type" : "string",- "format" : "date-time"- },- "created_at" : {- "type" : "string",- "format" : "date-time"- },- "active" : {- "type" : "boolean"- },- "creator_id" : {- "oneOf" : [ {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- }, {- "type" : "null"- } ]- }- },- "required" : [ "id", "active", "creator_id", "created_at", "updated_at", "payload_type", "payload_id", "last_check", "last_send" ]- },- "metabase-enterprise.notification-admin.api.run-status" : {- "type" : "string",- "enum" : [ "failing", "successful" ]- },- "metabase-enterprise.notification-admin.api.run-summary" : {- "type" : "object",- "properties" : {- "at" : {- "type" : "string",- "format" : "date-time"- },- "error" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "status" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.run-status"- }- },- "required" : [ "at", "error", "status" ],- "additionalProperties" : false- },- "metabase-enterprise.notification-admin.api.sort-column" : {- "type" : "string",- "enum" : [ "id", "last_send", "last_check", "card_name", "creator_name", "updated_at" ]- },- "metabase-enterprise.notification-admin.api.sort-direction" : {- "type" : "string",- "enum" : [ "asc", "desc" ]- },- "metabase-enterprise.notification-admin.api.tick-send-entry" : {- "description" : "One tick's worth of sends, rolled up across all channels that fired in that tick.",- "type" : "object",- "properties" : {- "at" : {- "type" : "string",- "format" : "date-time"- },- "channels" : {- "type" : "array",- "items" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.channel-entry"- }- },- "error" : {- "oneOf" : [ {- "type" : "string"- }, {- "type" : "null"- } ]- },- "status" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.run-status"- }- },- "required" : [ "at", "status", "error", "channels" ],- "additionalProperties" : false- },"metabase-enterprise.permission-debug.impl.group-id" : {"type" : "integer"},@@ -4125,9 +3871,12 @@"name" : {"type" : "string","minLength" : 1+ },+ "url" : {+ "type" : "string"}},- "required" : [ "id", "name", "collection_id", "description", "dashcard_ids" ]+ "required" : [ "id", "name", "url", "collection_id", "description", "dashcard_ids" ]},"metabase.agent-api.api.create-question-request" : {"type" : "object",@@ -4204,9 +3953,12 @@"name" : {"type" : "string","minLength" : 1+ },+ "url" : {+ "type" : "string"}},- "required" : [ "id", "name", "display", "collection_id", "description" ]+ "required" : [ "id", "name", "url", "display", "collection_id", "description" ]},"metabase.agent-api.api.dashcard-mutation" : {"description" : "One dashcard mutation. Discriminated on `:action`:\n - `add` : requires `card_id`. Auto-positioned. Optional `display_size`(\"wide\", \"tall\", or \"full\").\n - `remove` : requires `dashcard_id`.\n - `move` : requires `dashcard_id` and `position` (\"top\" or \"bottom\").",@@ -12037,6 +11789,260 @@} ]} ]},+ "metabase.notification.api.admin.bulk-response" : {+ "type" : "object",+ "properties" : {+ "updated" : {+ "description" : "value must be an integer greater or equal to than zero.",+ "type" : "integer",+ "minimum" : 0+ }+ },+ "required" : [ "updated" ]+ },+ "metabase.notification.api.admin.channel-entry" : {+ "description" : "One channel delivery attempt within a tick.",+ "type" : "object",+ "properties" : {+ "channel_type" : {+ "type" : "string"+ },+ "error" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "status" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"+ }+ },+ "required" : [ "channel_type", "status", "error" ],+ "additionalProperties" : false+ },+ "metabase.notification.api.admin.detail-response" : {+ "type" : "object",+ "properties" : {+ "last_check" : {+ "oneOf" : [ {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"+ }, {+ "type" : "null"+ } ]+ },+ "payload_type" : {+ "type" : "string"+ },+ "payload_id" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ },+ "send_history" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.tick-send-entry"+ }+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "check_history" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"+ }+ },+ "last_send" : {+ "oneOf" : [ {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"+ }, {+ "type" : "null"+ } ]+ },+ "updated_at" : {+ "type" : "string",+ "format" : "date-time"+ },+ "created_at" : {+ "type" : "string",+ "format" : "date-time"+ },+ "active" : {+ "type" : "boolean"+ },+ "creator_id" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "id", "active", "creator_id", "created_at", "updated_at", "payload_type", "payload_id", "last_check", "last_send", "check_history", "send_history" ]+ },+ "metabase.notification.api.admin.list-response" : {+ "type" : "object",+ "properties" : {+ "data" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.list-row"+ }+ },+ "limit" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ },+ "offset" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater or equal to than zero.",+ "type" : "integer",+ "minimum" : 0+ }, {+ "type" : "null"+ } ]+ },+ "total" : {+ "description" : "value must be an integer greater or equal to than zero.",+ "type" : "integer",+ "minimum" : 0+ }+ },+ "required" : [ "data", "total", "limit", "offset" ]+ },+ "metabase.notification.api.admin.list-row" : {+ "type" : "object",+ "properties" : {+ "last_check" : {+ "oneOf" : [ {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"+ }, {+ "type" : "null"+ } ]+ },+ "payload_type" : {+ "type" : "string"+ },+ "payload_id" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ },+ "id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "last_send" : {+ "oneOf" : [ {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-summary"+ }, {+ "type" : "null"+ } ]+ },+ "updated_at" : {+ "type" : "string",+ "format" : "date-time"+ },+ "created_at" : {+ "type" : "string",+ "format" : "date-time"+ },+ "active" : {+ "type" : "boolean"+ },+ "creator_id" : {+ "oneOf" : [ {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ }, {+ "type" : "null"+ } ]+ }+ },+ "required" : [ "id", "active", "creator_id", "created_at", "updated_at", "payload_type", "payload_id", "last_check", "last_send" ]+ },+ "metabase.notification.api.admin.run-status" : {+ "type" : "string",+ "enum" : [ "failing", "successful" ]+ },+ "metabase.notification.api.admin.run-summary" : {+ "type" : "object",+ "properties" : {+ "at" : {+ "type" : "string",+ "format" : "date-time"+ },+ "error" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "status" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"+ }+ },+ "required" : [ "at", "error", "status" ],+ "additionalProperties" : false+ },+ "metabase.notification.api.admin.sort-column" : {+ "type" : "string",+ "enum" : [ "id", "last_send", "last_check", "card_name", "creator_name", "updated_at" ]+ },+ "metabase.notification.api.admin.sort-direction" : {+ "type" : "string",+ "enum" : [ "asc", "desc" ]+ },+ "metabase.notification.api.admin.tick-send-entry" : {+ "description" : "One tick's worth of sends, rolled up across all channels that fired in that tick.",+ "type" : "object",+ "properties" : {+ "at" : {+ "type" : "string",+ "format" : "date-time"+ },+ "channels" : {+ "type" : "array",+ "items" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.channel-entry"+ }+ },+ "error" : {+ "oneOf" : [ {+ "type" : "string"+ }, {+ "type" : "null"+ } ]+ },+ "status" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"+ }+ },+ "required" : [ "at", "status", "error", "channels" ],+ "additionalProperties" : false+ },"metabase.notification.api.notification.NotificationApiInput" : {"description" : "Notification schema for API input. Like FullyHydratedNotification but restricts templates\n to user-provided types only (no handlebars-resource).","oneOf" : [ {@@ -28294,236 +28300,6 @@"tags" : [ "/api/ee/metabot" ]}},- "/api/ee/notifications" : {- "get" : {- "operationId" : "get-api-ee-notifications",- "summary" : "GET /api/ee/notifications",- "description" : "List card-type notifications (alerts) for admin management. Supports pagination (`limit` +\n `offset` query params — handled by the offset-paging middleware), filtering, and sorting.\n\n `last_send_status` filter operates on the latest channel-send task_history row for the\n notification's card (`successful` = latest channel-send succeeded; `failing` = latest\n channel-send failed). The Failing tab uses `?last_send_status=failing`.\n\n `creatorless=true` selects notifications with no creator or a deactivated creator (the Ownerless\n tab). `creatorless=false` selects the inverse.\n\n `channel` accepts a single string or a repeated query param for multi-select (OR logic).",- "parameters" : [ {- "in" : "query",- "name" : "active",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "creator_id",- "required" : false,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "in" : "query",- "name" : "creator_active",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "creatorless",- "required" : false,- "schema" : {- "oneOf" : [ {- "type" : "boolean"- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "card_id",- "required" : false,- "schema" : {- "type" : "integer",- "minimum" : 1- },- "description" : "value must be an integer greater than zero."- }, {- "in" : "query",- "name" : "recipient_email",- "required" : false,- "schema" : {- "type" : "string",- "minLength" : 1- }- }, {- "in" : "query",- "name" : "channel",- "required" : false,- "schema" : {- "oneOf" : [ {- "anyOf" : [ {- "type" : "string",- "minLength" : 1- }, {- "type" : "array",- "items" : {- "type" : "string",- "minLength" : 1- }- } ]- }, {- "type" : "null"- } ]- }- }, {- "in" : "query",- "name" : "last_send_status",- "required" : false,- "schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.run-status"- }- }, {- "in" : "query",- "name" : "query",- "required" : false,- "schema" : {- "type" : "string",- "minLength" : 1- }- }, {- "in" : "query",- "name" : "sort_column",- "required" : true,- "schema" : {- "default" : "last_send",- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.sort-column"- }- }, {- "in" : "query",- "name" : "sort_direction",- "required" : true,- "schema" : {- "default" : "desc",- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.sort-direction"- }- } ],- "responses" : {- "2XX" : {- "description" : "Successful response",- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.list-response"- }- }- }- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/ee/notifications" ]- }- },- "/api/ee/notifications/bulk" : {- "post" : {- "operationId" : "post-api-ee-notifications-bulk",- "summary" : "POST /api/ee/notifications/bulk",- "description" : "Bulk-archive or -change-creator a set of notifications. The per-notification `:active` flip goes\n through `:model/Notification`'s `before-update` hook, which creates / tears down the Quartz\n triggers. Recipient emails and `:event/notification-update` audit events are\n published via the shared [[notification-api/publish-notification-update!]] helper so this\n endpoint's side-effect contract can't drift from `PUT /api/notification/:id`.",- "parameters" : [ ],- "responses" : {- "2XX" : {- "description" : "Successful response",- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.bulk-response"- }- }- }- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "requestBody" : {- "content" : {- "application/json" : {- "schema" : {- "type" : "object",- "properties" : {- "action" : {- "type" : "string",- "enum" : [ "archive", "change-creator" ]- },- "creator_id" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "notification_ids" : {- "type" : "array",- "items" : {- "description" : "value must be an integer greater than zero.",- "type" : "integer",- "minimum" : 1- },- "minItems" : 1- }- },- "required" : [ "notification_ids", "action" ]- }- }- }- },- "tags" : [ "/api/ee/notifications" ]- }- },- "/api/ee/notifications/{id}" : {- "get" : {- "operationId" : "get-api-ee-notifications-id",- "summary" : "GET /api/ee/notifications/{id}",- "description" : "Get a single card-type notification with last_check, last_send, check_history (up to 10\n most-recent terminal alert-type TaskRuns) and send_history (up to 10 most-recent channel-send\n delivery attempts). 404 if the notification doesn't exist or isn't a card-type 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",- "content" : {- "application/json" : {- "schema" : {- "$ref" : "#/components/schemas/metabase-enterprise.notification-admin.api.detail-response"- }- }- }- },- "4XX" : {- "description" : "Client error response"- },- "5XX" : {- "description" : "Server error response"- }- },- "tags" : [ "/api/ee/notifications" ]- }- },"/api/ee/permission_debug" : {"get" : {"operationId" : "get-api-ee-permission_debug",@@ -38882,6 +38658,236 @@"tags" : [ "/api/notification" ]}},+ "/api/notification/admin" : {+ "get" : {+ "operationId" : "get-api-notification-admin",+ "summary" : "GET /api/notification/admin",+ "description" : "List card-type notifications (alerts) for admin management. Supports pagination (`limit` +\n `offset` query params — handled by the offset-paging middleware), filtering, and sorting.\n\n `last_send_status` filter operates on the latest channel-send task_history row for the\n notification's card (`successful` = latest channel-send succeeded; `failing` = latest\n channel-send failed). The Failing tab uses `?last_send_status=failing`.\n\n `creatorless=true` selects notifications with no creator or a deactivated creator (the Ownerless\n tab). `creatorless=false` selects the inverse.\n\n `channel` accepts a single string or a repeated query param for multi-select (OR logic).",+ "parameters" : [ {+ "in" : "query",+ "name" : "active",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "creator_id",+ "required" : false,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "creator_active",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "creatorless",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "type" : "boolean"+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "card_id",+ "required" : false,+ "schema" : {+ "type" : "integer",+ "minimum" : 1+ },+ "description" : "value must be an integer greater than zero."+ }, {+ "in" : "query",+ "name" : "recipient_email",+ "required" : false,+ "schema" : {+ "type" : "string",+ "minLength" : 1+ }+ }, {+ "in" : "query",+ "name" : "channel",+ "required" : false,+ "schema" : {+ "oneOf" : [ {+ "anyOf" : [ {+ "type" : "string",+ "minLength" : 1+ }, {+ "type" : "array",+ "items" : {+ "type" : "string",+ "minLength" : 1+ }+ } ]+ }, {+ "type" : "null"+ } ]+ }+ }, {+ "in" : "query",+ "name" : "last_send_status",+ "required" : false,+ "schema" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.run-status"+ }+ }, {+ "in" : "query",+ "name" : "query",+ "required" : false,+ "schema" : {+ "type" : "string",+ "minLength" : 1+ }+ }, {+ "in" : "query",+ "name" : "sort_column",+ "required" : true,+ "schema" : {+ "default" : "last_send",+ "$ref" : "#/components/schemas/metabase.notification.api.admin.sort-column"+ }+ }, {+ "in" : "query",+ "name" : "sort_direction",+ "required" : true,+ "schema" : {+ "default" : "desc",+ "$ref" : "#/components/schemas/metabase.notification.api.admin.sort-direction"+ }+ } ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.list-response"+ }+ }+ }+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/notification/admin" ]+ }+ },+ "/api/notification/admin/bulk" : {+ "post" : {+ "operationId" : "post-api-notification-admin-bulk",+ "summary" : "POST /api/notification/admin/bulk",+ "description" : "Bulk-archive or -change-creator a set of notifications. The per-notification `:active` flip goes\n through `:model/Notification`'s `before-update` hook, which creates / tears down the Quartz\n triggers. Recipient emails and `:event/notification-update` audit events are\n published via the shared [[notification-api/publish-notification-update!]] helper so this\n endpoint's side-effect contract can't drift from `PUT /api/notification/:id`.",+ "parameters" : [ ],+ "responses" : {+ "2XX" : {+ "description" : "Successful response",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.bulk-response"+ }+ }+ }+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "requestBody" : {+ "content" : {+ "application/json" : {+ "schema" : {+ "type" : "object",+ "properties" : {+ "action" : {+ "type" : "string",+ "enum" : [ "archive", "change-creator" ]+ },+ "creator_id" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "notification_ids" : {+ "type" : "array",+ "items" : {+ "description" : "value must be an integer greater than zero.",+ "type" : "integer",+ "minimum" : 1+ },+ "minItems" : 1+ }+ },+ "required" : [ "notification_ids", "action" ]+ }+ }+ }+ },+ "tags" : [ "/api/notification/admin" ]+ }+ },+ "/api/notification/admin/{id}" : {+ "get" : {+ "operationId" : "get-api-notification-admin-id",+ "summary" : "GET /api/notification/admin/{id}",+ "description" : "Get a single card-type notification with last_check, last_send, check_history (up to 10\n most-recent terminal alert-type TaskRuns) and send_history (up to 10 most-recent channel-send\n delivery attempts). 404 if the notification doesn't exist or isn't a card-type 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",+ "content" : {+ "application/json" : {+ "schema" : {+ "$ref" : "#/components/schemas/metabase.notification.api.admin.detail-response"+ }+ }+ }+ },+ "4XX" : {+ "description" : "Client error response"+ },+ "5XX" : {+ "description" : "Server error response"+ }+ },+ "tags" : [ "/api/notification/admin" ]+ }+ },"/api/notification/send" : {"post" : {"operationId" : "post-api-notification-send",@@ -48059,7 +48065,7 @@"required" : false,"schema" : {"type" : "string",- "enum" : [ "transform-name", "start-time", "end-time", "status", "run-method", "transform-tags" ]+ "enum" : [ "transform-name", "start-time", "end-time", "status", "run-method", "transform-tags", "duration" ]}}, {"in" : "query",diff --git a/docs/installation-and-operation/commands.md b/docs/installation-and-operation/commands.mdindex 0d10d6933c0..939bf43736e 100644--- a/docs/installation-and-operation/commands.md+++ b/docs/installation-and-operation/commands.md@@ -17,6 +17,7 @@ java --add-opens java.base/java.nio=ALL-UNNAMED -jar metabase.jar helpMetabase will print out the help text for available commands.+## `api-documentation`Generate an HTML file and a JSON file for Scalar docs for the Metabase API.@@ -119,3 +120,4 @@ Open an SQL shell for the Metabase H2 DB:```shjava -cp metabase.jar org.h2.tools.Shell -url jdbc:h2:/path/to/metabase.db```+