Skip to content

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

Update generated docs (master) (#66228)

github-automation-metabase81f10bdb3cbe
diff --git a/docs/api.json b/docs/api.json
index 0afd4490a80..eb1c8a0be10 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -245,6 +245,18 @@
} ]
},
"mbql.clause.coalesce" : { },
+ "mbql.clause.collate" : {
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "collate"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.options"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.string"
+ }, {
+ "type" : "string"
+ } ]
+ },
"mbql.clause.concat" : { },
"mbql.clause.contains" : { },
"mbql.clause.convert-timezone" : { },
@@ -3259,6 +3271,114 @@
"description" : "value must be a valid attribute remappings map (attribute name -> remapped name)",
"optional" : true
},
+ "metabase-enterprise.support-access-grants.schema.create-grant-request" : {
+ "description" : "Schema for POST /api/ee/support-access-grants request body.",
+ "type" : "object",
+ "properties" : {
+ "grant_duration_minutes" : {
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 10080
+ },
+ "notes" : {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 255
+ },
+ "ticket_number" : {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 100
+ }
+ },
+ "required" : [ "grant_duration_minutes" ]
+ },
+ "metabase-enterprise.support-access-grants.schema.current-grant-response" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response",
+ "description" : "Schema for GET /api/ee/support-access-grants/current response.",
+ "optional" : true
+ },
+ "metabase-enterprise.support-access-grants.schema.grant-response" : {
+ "description" : "Schema for a support access grant object in API responses.",
+ "type" : "object",
+ "properties" : {
+ "user_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "token" : {
+ "type" : "string"
+ },
+ "user_name" : {
+ "type" : "string"
+ },
+ "user_email" : {
+ "type" : "string"
+ },
+ "grant_end_timestamp" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ },
+ "revoked_at" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ },
+ "revoked_by_user_id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "ticket_number" : {
+ "type" : "string"
+ },
+ "updated_at" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ },
+ "created_at" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ },
+ "notes" : {
+ "type" : "string"
+ },
+ "grant_start_timestamp" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.timestamp"
+ }
+ },
+ "required" : [ "id", "user_id", "grant_start_timestamp", "grant_end_timestamp", "created_at", "updated_at" ]
+ },
+ "metabase-enterprise.support-access-grants.schema.list-grants-response" : {
+ "description" : "Schema for GET /api/ee/support-access-grants response (paginated list).",
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
+ }
+ },
+ "limit" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "offset" : {
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "total" : {
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "data", "total", "limit", "offset" ]
+ },
+ "metabase-enterprise.support-access-grants.schema.timestamp" : {
+ "anyOf" : [ { }, { } ]
+ },
"metabase-enterprise.transforms.api.run-trigger" : {
"type" : "string",
"enum" : [ "none", "global-schedule" ]
@@ -5183,6 +5303,8 @@
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.text"
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.split-part"
+ }, {
+ "$ref" : "#/components/schemas/metabase.legacy-mbql.schema.collate"
} ]
},
"metabase.legacy-mbql.schema.StringExpressionArg" : {
@@ -5397,6 +5519,10 @@
"description" : "schema for a valid MBQL 4 :coalesce clause",
"allOf" : [ ]
},
+ "metabase.legacy-mbql.schema.collate" : {
+ "description" : "schema for a valid MBQL 4 :collate clause",
+ "allOf" : [ ]
+ },
"metabase.legacy-mbql.schema.concat" : {
"description" : "schema for a valid MBQL 4 :concat clause",
"allOf" : [ ]
@@ -6830,6 +6956,8 @@
"$ref" : "#/components/schemas/mbql.clause.ceil"
}, {
"$ref" : "#/components/schemas/mbql.clause.coalesce"
+ }, {
+ "$ref" : "#/components/schemas/mbql.clause.collate"
}, {
"$ref" : "#/components/schemas/mbql.clause.concat"
}, {
@@ -12395,10 +12523,6 @@
"description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
- },
- "type" : {
- "type" : "string",
- "enum" : [ "remote-synced" ]
}
},
"required" : [ "name" ]
@@ -21089,6 +21213,149 @@
"tags" : [ "/api/ee/stale" ]
}
},
+ "/api/ee/support-access-grant/" : {
+ "post" : {
+ "summary" : "POST /api/ee/support-access-grant/",
+ "description" : "Create a new support access grant.\n\n Requires superuser permissions. Only one active grant can exist at a time.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Schema for a support access grant object in API responses.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.create-grant-request"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/support-access-grant" ]
+ },
+ "get" : {
+ "summary" : "GET /api/ee/support-access-grant/",
+ "description" : "List support access grants with optional filtering and pagination.\n\n Requires superuser permissions.\n\n Query parameters:\n - ticket-number: Filter by ticket number\n - user-id: Filter by user who created the grant\n - include-revoked: Include revoked grants (default false)",
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "ticket-number",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "user-id",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "query",
+ "name" : "include-revoked",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Schema for GET /api/ee/support-access-grants response (paginated list).",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.list-grants-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/support-access-grant" ]
+ }
+ },
+ "/api/ee/support-access-grant/current" : {
+ "get" : {
+ "summary" : "GET /api/ee/support-access-grant/current",
+ "description" : "Get the currently active support access grant, if one exists.\n\n Requires superuser permissions.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Schema for GET /api/ee/support-access-grants/current response.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.current-grant-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/support-access-grant" ]
+ }
+ },
+ "/api/ee/support-access-grant/{id}/revoke" : {
+ "put" : {
+ "summary" : "PUT /api/ee/support-access-grant/{id}/revoke",
+ "description" : "Revoke an existing support access grant.\n\n Requires superuser permissions. Any admin can revoke any grant.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Schema for a support access grant object in API responses.",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.support-access-grants.schema.grant-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/support-access-grant" ]
+ }
+ },
"/api/ee/transform-job/" : {
"post" : {
"summary" : "POST /api/ee/transform-job/",
@@ -25815,6 +26082,25 @@
"tags" : [ "/api/preview_embed" ]
}
},
+ "/api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}" : {
+ "get" : {
+ "summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/search/{prefix}",
+ "description" : "Embedded version of chain filter search endpoint.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/preview_embed" ]
+ }
+ },
"/api/preview_embed/dashboard/{token}/params/{param-key}/values" : {
"get" : {
"summary" : "GET /api/preview_embed/dashboard/{token}/params/{param-key}/values",
diff --git a/docs/installation-and-operation/commands.md b/docs/installation-and-operation/commands.md
index 4a0300add63..c380993f41d 100644
--- a/docs/installation-and-operation/commands.md
+++ b/docs/installation-and-operation/commands.md
@@ -18,7 +18,7 @@ Metabase will print out the help text for available commands.
## `api-documentation`
-Generate a markdown file containing documentation for all API endpoints. This is written to a file called `docs/api-documentation.md`.
+Generate an HTML file and a JSON file for Scalar docs for the Metabase API.
## `command-documentation`