From 5cc9974c845f352b5bc8cedbc84aff8955d1868e Mon Sep 17 00:00:00 2001 From: Metabase Docs bot Date: Wed, 26 Nov 2025 01:46:00 +0000 Subject: [PATCH] [auto] adding content to master->master --- _docs/master/api.json | 296 +++++++++++++++++- _docs/master/embedding/sdk/api/IconName.html | 2 +- .../sdk/api/MetabaseCollectionItem.html | 4 +- .../embedding/sdk/api/snippets/IconName.md | 8 + .../api/snippets/MetabaseCollectionItem.md | 45 +-- .../installation-and-operation/commands.md | 2 +- _site/docs/master/api.json | 296 +++++++++++++++++- .../master/embedding/sdk/api/IconName.html | 2 +- .../sdk/api/MetabaseCollectionItem.html | 4 +- .../installation-and-operation/commands.html | 2 +- 10 files changed, 627 insertions(+), 34 deletions(-) diff --git a/_docs/master/api.json b/_docs/master/api.json index 9aba288fb..eb1c8a0be 100644 --- a/_docs/master/api.json +++ b/_docs/master/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" }, { @@ -9704,6 +9832,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/activity" ] } }, @@ -12394,10 +12523,6 @@ "description" : "value must be an integer greater than zero.", "type" : "integer", "minimum" : 1 - }, - "type" : { - "type" : "string", - "enum" : [ "remote-synced" ] } }, "required" : [ "name" ] @@ -13109,6 +13234,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/dashboard" ] }, "post" : { @@ -21087,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/", @@ -25813,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/master/embedding/sdk/api/IconName.html b/_docs/master/embedding/sdk/api/IconName.html index 900cf9c50..5bdc99fcd 100644 --- a/_docs/master/embedding/sdk/api/IconName.html +++ b/_docs/master/embedding/sdk/api/IconName.html @@ -9,4 +9,4 @@ layout: docs-api --- -IconName | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}
Embedded analytics SDK API
    Preparing search index...

    Type Alias IconName

    IconName:
        | "string"
        | "number"
        | "function"
        | "collection"
        | "dashboard"
        | "question"
        | "model"
        | "archive"
        | "table"
        | "bar"
        | "line"
        | "pie"
        | "scalar"
        | "area"
        | "smartscalar"
        | "gauge"
        | "progress"
        | "funnel"
        | "waterfall"
        | "sankey"
        | "list"
        | "revert"
        | "add"
        | "add_column"
        | "add_data"
        | "add_folder"
        | "add_list"
        | "add_row"
        | "add_to_dash"
        | "add_comment"
        | "ai"
        | "alert"
        | "alert_filled"
        | "alert_confirm"
        | "attachment"
        | "arrow_up"
        | "arrow_down"
        | "arrow_left"
        | "arrow_left_to_line"
        | "arrow_right"
        | "arrow_split"
        | "audit"
        | "badge"
        | "ban"
        | "bell"
        | "birthday"
        | "bookmark"
        | "bookmark_filled"
        | "bolt"
        | "bolt_filled"
        | "breakout"
        | "bubble"
        | "burger"
        | "calendar"
        | "camera"
        | "check"
        | "check_filled"
        | "code_block"
        | "chevrondown"
        | "chevronleft"
        | "chevronright"
        | "chevronup"
        | "click"
        | "clipboard"
        | "clock"
        | "clone"
        | "close"
        | "cloud"
        | "cloud_filled"
        | "compare"
        | "combine"
        | "company"
        | "comment"
        | "currency"
        | "connections"
        | "contract"
        | "copy"
        | "curved"
        | "database"
        | "dash"
        | "curve"
        | "document"
        | "download"
        | "dyno"
        | "edit_document"
        | "edit_document_outlined"
        | "ellipsis"
        | "embed"
        | "embed_interactive"
        | "embed_modular"
        | "embed_static"
        | "empty"
        | "enter_or_return"
        | "expand"
        | "expand_arrow"
        | "extract"
        | "eye"
        | "eye_crossed_out"
        | "eye_outline"
        | "factory"
        | "field"
        | "fields"
        | "filter"
        | "filter_plus"
        | "bug"
        | "format_code"
        | "formula"
        | "funnel_outline"
        | "folder"
        | "folder_filled"
        | "gear"
        | "gear_settings_filled"
        | "gem"
        | "globe"
        | "git_branch"
        | "grabber"
        | "grid"
        | "group"
        | "google"
        | "google_drive"
        | "google_sheet"
        | "history"
        | "home"
        | "horizontal_bar"
        | "hourglass"
        | "info"
        | "info_outline"
        | "insight"
        | "int"
        | "io"
        | "join_full_outer"
        | "join_inner"
        | "join_left_outer"
        | "join_right_outer"
        | "index"
        | "key"
        | "label"
        | "ldap"
        | "learn"
        | "lightbulb"
        | "link"
        | "lines"
        | "lineandbar"
        | "line_style_dashed"
        | "line_style_dotted"
        | "line_style_solid"
        | "location"
        | "lock"
        | "lock_filled"
        | "mail"
        | "mail_filled"
        | "message_circle"
        | "metabot"
        | "metabot_sad"
        | "metric"
        | "model_with_badge"
        | "moon"
        | "move"
        | "move_card"
        | "new_folder"
        | "notebook"
        | "octagon_alert"
        | "package"
        | "palette"
        | "pause"
        | "pencil"
        | "pencil_lines"
        | "permissions_limited"
        | "person"
        | "pin"
        | "pinmap"
        | "pivot_table"
        | "play"
        | "play_outlined"
        | "popover"
        | "popular"
        | "pulse"
        | "receipt"
        | "recents"
        | "share"
        | "send"
        | "smile"
        | "split"
        | "sql"
        | "subscription"
        | "straight"
        | "stepped"
        | "sticky_note"
        | "sort"
        | "sort_arrows"
        | "sum"
        | "sync"
        | "synced_collection"
        | "quote"
        | "redo"
        | "return"
        | "reference"
        | "refresh"
        | "refresh_downstream"
        | "repository"
        | "rocket"
        | "ruler"
        | "schema"
        | "search"
        | "section"
        | "segment"
        | "shield"
        | "shield_outline"
        | "sidebar_closed"
        | "sidebar_open"
        | "slack"
        | "slack_colorized"
        | "snail"
        | "snippet"
        | "sparkles"
        | "star_filled"
        | "star"
        | "stop"
        | "store"
        | "sun"
        | "t-shirt"
        | "tab"
        | "table2"
        | "text_bold"
        | "text_italic"
        | "text_strike"
        | "thumbs_down"
        | "thumbs_up"
        | "time_history"
        | "trash"
        | "trash_filled"
        | "triangle_left"
        | "triangle_right"
        | "unarchive"
        | "undo"
        | "unknown"
        | "unpin"
        | "unsubscribe"
        | "upload"
        | "variable"
        | "verified"
        | "official_collection"
        | "ordered_list"
        | "verified_filled"
        | "view_archive"
        | "warning"
        | "warning_round_filled"
        | "warning_triangle_filled"
        | "webhook"
        | "10k"
        | "1m"
        | "zap"
        | "zoom_in"
        | "zoom_out"
        | "cake"
        | "external"
        | "table_spaced"
        | "beaker"
        | "test_tube"
        | "eye_filled"

    Settings

    +IconName | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}
    Embedded analytics SDK API
      Preparing search index...

      Type Alias IconName

      IconName:
          | "string"
          | "number"
          | "function"
          | "collection"
          | "dashboard"
          | "question"
          | "model"
          | "archive"
          | "table"
          | "bar"
          | "line"
          | "pie"
          | "scalar"
          | "area"
          | "smartscalar"
          | "gauge"
          | "progress"
          | "funnel"
          | "waterfall"
          | "sankey"
          | "list"
          | "revert"
          | "add"
          | "add_column"
          | "add_data"
          | "add_folder"
          | "add_list"
          | "add_row"
          | "add_to_dash"
          | "add_comment"
          | "ai"
          | "alert"
          | "alert_filled"
          | "alert_confirm"
          | "attachment"
          | "arrow_up"
          | "arrow_down"
          | "arrow_left"
          | "arrow_left_to_line"
          | "arrow_right"
          | "arrow_split"
          | "audit"
          | "badge"
          | "ban"
          | "bell"
          | "birthday"
          | "book_open"
          | "bookmark"
          | "bookmark_filled"
          | "bolt"
          | "bolt_filled"
          | "breakout"
          | "bubble"
          | "burger"
          | "calendar"
          | "camera"
          | "check"
          | "check_filled"
          | "code_block"
          | "chevrondown"
          | "chevronleft"
          | "chevronright"
          | "chevronup"
          | "click"
          | "clipboard"
          | "clock"
          | "clone"
          | "close"
          | "cloud"
          | "cloud_filled"
          | "collection2"
          | "compare"
          | "combine"
          | "company"
          | "comment"
          | "currency"
          | "connections"
          | "contract"
          | "copy"
          | "curved"
          | "database"
          | "data_studio"
          | "dash"
          | "curve"
          | "document"
          | "download"
          | "dyno"
          | "edit_document"
          | "edit_document_outlined"
          | "ellipsis"
          | "embed"
          | "embed_interactive"
          | "embed_modular"
          | "embed_static"
          | "empty"
          | "enter_or_return"
          | "expand"
          | "expand_arrow"
          | "extract"
          | "eye"
          | "eye_crossed_out"
          | "eye_outline"
          | "factory"
          | "field"
          | "fields"
          | "filter"
          | "filter_plus"
          | "bug"
          | "format_code"
          | "formula"
          | "funnel_outline"
          | "folder"
          | "folder_filled"
          | "gear"
          | "gear_settings_filled"
          | "gem"
          | "globe"
          | "git_branch"
          | "grabber"
          | "grid"
          | "group"
          | "google"
          | "google_drive"
          | "google_sheet"
          | "history"
          | "home"
          | "horizontal_bar"
          | "hourglass"
          | "info"
          | "info_outline"
          | "insight"
          | "int"
          | "io"
          | "join_full_outer"
          | "join_inner"
          | "join_left_outer"
          | "join_right_outer"
          | "index"
          | "key"
          | "label"
          | "ldap"
          | "learn"
          | "lightbulb"
          | "link"
          | "lines"
          | "lineandbar"
          | "line_style_dashed"
          | "line_style_dotted"
          | "line_style_solid"
          | "location"
          | "lock"
          | "lock_filled"
          | "mail"
          | "mail_filled"
          | "medallion"
          | "message_circle"
          | "metabot"
          | "metabot_sad"
          | "metric"
          | "model_with_badge"
          | "moon"
          | "move"
          | "move_card"
          | "network"
          | "new_folder"
          | "notebook"
          | "octagon_alert"
          | "package"
          | "palette"
          | "pause"
          | "pencil"
          | "pencil_lines"
          | "permissions_limited"
          | "person"
          | "pin"
          | "pinmap"
          | "pivot_table"
          | "play"
          | "play_outlined"
          | "popover"
          | "popular"
          | "pulse"
          | "receipt"
          | "recents"
          | "share"
          | "send"
          | "settings"
          | "smile"
          | "split"
          | "sql"
          | "subscription"
          | "straight"
          | "stepped"
          | "sticky_note"
          | "sort"
          | "sort_arrows"
          | "sum"
          | "sync"
          | "synced_collection"
          | "transform"
          | "quote"
          | "redo"
          | "return"
          | "reference"
          | "refresh"
          | "refresh_downstream"
          | "repository"
          | "rocket"
          | "ruler"
          | "schema"
          | "search"
          | "section"
          | "segment"
          | "shield"
          | "shield_outline"
          | "sidebar_closed"
          | "sidebar_open"
          | "slack"
          | "slack_colorized"
          | "snail"
          | "snippet"
          | "sparkles"
          | "star_filled"
          | "star"
          | "stop"
          | "store"
          | "sun"
          | "t-shirt"
          | "tab"
          | "table2"
          | "text_bold"
          | "text_italic"
          | "text_strike"
          | "thumbs_down"
          | "thumbs_up"
          | "time_history"
          | "trash"
          | "trash_filled"
          | "triangle_left"
          | "triangle_right"
          | "unarchive"
          | "undo"
          | "unknown"
          | "unpin"
          | "unsubscribe"
          | "upload"
          | "variable"
          | "verified"
          | "official_collection"
          | "ordered_list"
          | "verified_filled"
          | "verified_round"
          | "view_archive"
          | "warning"
          | "warning_round_filled"
          | "warning_triangle_filled"
          | "webhook"
          | "10k"
          | "1m"
          | "zap"
          | "zoom_in"
          | "zoom_out"
          | "cake"
          | "external"
          | "table_spaced"
          | "beaker"
          | "test_tube"
          | "eye_filled"

      Settings

      diff --git a/_docs/master/embedding/sdk/api/MetabaseCollectionItem.html b/_docs/master/embedding/sdk/api/MetabaseCollectionItem.html index a8a8d8c07..d7b663cd4 100644 --- a/_docs/master/embedding/sdk/api/MetabaseCollectionItem.html +++ b/_docs/master/embedding/sdk/api/MetabaseCollectionItem.html @@ -10,7 +10,7 @@ --- MetabaseCollectionItem | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}
      Embedded analytics SDK API
        Preparing search index...

        Type Alias MetabaseCollectionItem

        The CollectionItem entity

        -
        type MetabaseCollectionItem = {
            description: string | null;
            entity_id?: SdkEntityId;
            id: SdkCollectionId;
            is_remote_synced?: boolean;
            "last-edit-info"?: {
                email: string;
                first_name: string;
                id: SdkUserId;
                last_name: string;
                timestamp: string;
            };
            model: string;
            name: string;
            type?: | "instance-analytics"
            | "trash"
            | "model"
            | "question"
            | "metric"
            | null;
        }
        Index

        Properties

        description +
        type MetabaseCollectionItem = {
            description: string | null;
            entity_id?: SdkEntityId;
            id: SdkCollectionId;
            is_remote_synced?: boolean;
            "last-edit-info"?: {
                email: string;
                first_name: string | null;
                id: SdkUserId;
                last_name: string | null;
                timestamp: string;
            };
            model: string;
            name: string;
            type?: | "instance-analytics"
            | "trash"
            | "remote-synced"
            | "library"
            | "library-models"
            | "library-metrics"
            | "model"
            | "question"
            | "metric"
            | null;
        }
        Index

        Properties

        description entity_id? id is_remote_synced? @@ -18,4 +18,4 @@ model name type? -

        Properties

        description: string | null
        entity_id?: SdkEntityId
        id: SdkCollectionId
        is_remote_synced?: boolean
        "last-edit-info"?: {
            email: string;
            first_name: string;
            id: SdkUserId;
            last_name: string;
            timestamp: string;
        }
        model: string
        name: string
        type?: "instance-analytics" | "trash" | "model" | "question" | "metric" | null

        Settings

        On This Page

        Properties

        +

        Properties

        description: string | null
        entity_id?: SdkEntityId
        id: SdkCollectionId
        is_remote_synced?: boolean
        "last-edit-info"?: {
            email: string;
            first_name: string | null;
            id: SdkUserId;
            last_name: string | null;
            timestamp: string;
        }
        model: string
        name: string
        type?:
            | "instance-analytics"
            | "trash"
            | "remote-synced"
            | "library"
            | "library-models"
            | "library-metrics"
            | "model"
            | "question"
            | "metric"
            | null

        Settings

        On This Page

        Properties
        diff --git a/_docs/master/embedding/sdk/api/snippets/IconName.md b/_docs/master/embedding/sdk/api/snippets/IconName.md index c004037f1..4a4be617e 100644 --- a/_docs/master/embedding/sdk/api/snippets/IconName.md +++ b/_docs/master/embedding/sdk/api/snippets/IconName.md @@ -57,6 +57,7 @@ type IconName = | "ban" | "bell" | "birthday" + | "book_open" | "bookmark" | "bookmark_filled" | "bolt" @@ -80,6 +81,7 @@ type IconName = | "close" | "cloud" | "cloud_filled" + | "collection2" | "compare" | "combine" | "company" @@ -90,6 +92,7 @@ type IconName = | "copy" | "curved" | "database" + | "data_studio" | "dash" | "curve" | "document" @@ -162,6 +165,7 @@ type IconName = | "lock_filled" | "mail" | "mail_filled" + | "medallion" | "message_circle" | "metabot" | "metabot_sad" @@ -170,6 +174,7 @@ type IconName = | "moon" | "move" | "move_card" + | "network" | "new_folder" | "notebook" | "octagon_alert" @@ -192,6 +197,7 @@ type IconName = | "recents" | "share" | "send" + | "settings" | "smile" | "split" | "sql" @@ -204,6 +210,7 @@ type IconName = | "sum" | "sync" | "synced_collection" + | "transform" | "quote" | "redo" | "return" @@ -255,6 +262,7 @@ type IconName = | "official_collection" | "ordered_list" | "verified_filled" + | "verified_round" | "view_archive" | "warning" | "warning_round_filled" diff --git a/_docs/master/embedding/sdk/api/snippets/MetabaseCollectionItem.md b/_docs/master/embedding/sdk/api/snippets/MetabaseCollectionItem.md index 773d712f3..b3d19630a 100644 --- a/_docs/master/embedding/sdk/api/snippets/MetabaseCollectionItem.md +++ b/_docs/master/embedding/sdk/api/snippets/MetabaseCollectionItem.md @@ -17,14 +17,23 @@ type MetabaseCollectionItem = { is_remote_synced?: boolean; last-edit-info?: { email: string; - first_name: string; + first_name: string | null; id: SdkUserId; - last_name: string; + last_name: string | null; timestamp: string; }; model: string; name: string; - type?: "instance-analytics" | "trash" | "model" | "question" | "metric" | null; + type?: | "instance-analytics" + | "trash" + | "remote-synced" + | "library" + | "library-models" + | "library-metrics" + | "model" + | "question" + | "metric" + | null; }; ``` @@ -34,20 +43,20 @@ The CollectionItem entity -| Property | Type | -| :------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------- | -| `description` | `string` \| `null` | -| `entity_id?` | [`SdkEntityId`](./api/SdkEntityId) | -| `id` | [`SdkCollectionId`](./api/SdkCollectionId) | -| `is_remote_synced?` | `boolean` | -| `last-edit-info?` | \{ `email`: `string`; `first_name`: `string`; `id`: [`SdkUserId`](./api/SdkUserId); `last_name`: `string`; `timestamp`: `string`; \} | -| `last-edit-info.email` | `string` | -| `last-edit-info.first_name` | `string` | -| `last-edit-info.id` | [`SdkUserId`](./api/SdkUserId) | -| `last-edit-info.last_name` | `string` | -| `last-edit-info.timestamp` | `string` | -| `model` | `string` | -| `name` | `string` | -| `type?` | `"instance-analytics"` \| `"trash"` \| `"model"` \| `"question"` \| `"metric"` \| `null` | +| Property | Type | +| :------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `description` | `string` \| `null` | +| `entity_id?` | [`SdkEntityId`](./api/SdkEntityId) | +| `id` | [`SdkCollectionId`](./api/SdkCollectionId) | +| `is_remote_synced?` | `boolean` | +| `last-edit-info?` | \{ `email`: `string`; `first_name`: `string` \| `null`; `id`: [`SdkUserId`](./api/SdkUserId); `last_name`: `string` \| `null`; `timestamp`: `string`; \} | +| `last-edit-info.email` | `string` | +| `last-edit-info.first_name` | `string` \| `null` | +| `last-edit-info.id` | [`SdkUserId`](./api/SdkUserId) | +| `last-edit-info.last_name` | `string` \| `null` | +| `last-edit-info.timestamp` | `string` | +| `model` | `string` | +| `name` | `string` | +| `type?` | \| `"instance-analytics"` \| `"trash"` \| `"remote-synced"` \| `"library"` \| `"library-models"` \| `"library-metrics"` \| `"model"` \| `"question"` \| `"metric"` \| `null` | diff --git a/_docs/master/installation-and-operation/commands.md b/_docs/master/installation-and-operation/commands.md index 2681b5896..3ec2a5c96 100644 --- a/_docs/master/installation-and-operation/commands.md +++ b/_docs/master/installation-and-operation/commands.md @@ -25,7 +25,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` diff --git a/_site/docs/master/api.json b/_site/docs/master/api.json index 9aba288fb..eb1c8a0be 100644 --- a/_site/docs/master/api.json +++ b/_site/docs/master/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" }, { @@ -9704,6 +9832,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/activity" ] } }, @@ -12394,10 +12523,6 @@ "description" : "value must be an integer greater than zero.", "type" : "integer", "minimum" : 1 - }, - "type" : { - "type" : "string", - "enum" : [ "remote-synced" ] } }, "required" : [ "name" ] @@ -13109,6 +13234,7 @@ "description" : "Server error response" } }, + "deprecated" : true, "tags" : [ "/api/dashboard" ] }, "post" : { @@ -21087,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/", @@ -25813,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/_site/docs/master/embedding/sdk/api/IconName.html b/_site/docs/master/embedding/sdk/api/IconName.html index 1f9b6abbb..a24794ff7 100644 --- a/_site/docs/master/embedding/sdk/api/IconName.html +++ b/_site/docs/master/embedding/sdk/api/IconName.html @@ -23,6 +23,6 @@ -
        Embedded analytics SDK API
          Preparing search index...

          Type Alias IconName

          IconName:
              | "string"
              | "number"
              | "function"
              | "collection"
              | "dashboard"
              | "question"
              | "model"
              | "archive"
              | "table"
              | "bar"
              | "line"
              | "pie"
              | "scalar"
              | "area"
              | "smartscalar"
              | "gauge"
              | "progress"
              | "funnel"
              | "waterfall"
              | "sankey"
              | "list"
              | "revert"
              | "add"
              | "add_column"
              | "add_data"
              | "add_folder"
              | "add_list"
              | "add_row"
              | "add_to_dash"
              | "add_comment"
              | "ai"
              | "alert"
              | "alert_filled"
              | "alert_confirm"
              | "attachment"
              | "arrow_up"
              | "arrow_down"
              | "arrow_left"
              | "arrow_left_to_line"
              | "arrow_right"
              | "arrow_split"
              | "audit"
              | "badge"
              | "ban"
              | "bell"
              | "birthday"
              | "bookmark"
              | "bookmark_filled"
              | "bolt"
              | "bolt_filled"
              | "breakout"
              | "bubble"
              | "burger"
              | "calendar"
              | "camera"
              | "check"
              | "check_filled"
              | "code_block"
              | "chevrondown"
              | "chevronleft"
              | "chevronright"
              | "chevronup"
              | "click"
              | "clipboard"
              | "clock"
              | "clone"
              | "close"
              | "cloud"
              | "cloud_filled"
              | "compare"
              | "combine"
              | "company"
              | "comment"
              | "currency"
              | "connections"
              | "contract"
              | "copy"
              | "curved"
              | "database"
              | "dash"
              | "curve"
              | "document"
              | "download"
              | "dyno"
              | "edit_document"
              | "edit_document_outlined"
              | "ellipsis"
              | "embed"
              | "embed_interactive"
              | "embed_modular"
              | "embed_static"
              | "empty"
              | "enter_or_return"
              | "expand"
              | "expand_arrow"
              | "extract"
              | "eye"
              | "eye_crossed_out"
              | "eye_outline"
              | "factory"
              | "field"
              | "fields"
              | "filter"
              | "filter_plus"
              | "bug"
              | "format_code"
              | "formula"
              | "funnel_outline"
              | "folder"
              | "folder_filled"
              | "gear"
              | "gear_settings_filled"
              | "gem"
              | "globe"
              | "git_branch"
              | "grabber"
              | "grid"
              | "group"
              | "google"
              | "google_drive"
              | "google_sheet"
              | "history"
              | "home"
              | "horizontal_bar"
              | "hourglass"
              | "info"
              | "info_outline"
              | "insight"
              | "int"
              | "io"
              | "join_full_outer"
              | "join_inner"
              | "join_left_outer"
              | "join_right_outer"
              | "index"
              | "key"
              | "label"
              | "ldap"
              | "learn"
              | "lightbulb"
              | "link"
              | "lines"
              | "lineandbar"
              | "line_style_dashed"
              | "line_style_dotted"
              | "line_style_solid"
              | "location"
              | "lock"
              | "lock_filled"
              | "mail"
              | "mail_filled"
              | "message_circle"
              | "metabot"
              | "metabot_sad"
              | "metric"
              | "model_with_badge"
              | "moon"
              | "move"
              | "move_card"
              | "new_folder"
              | "notebook"
              | "octagon_alert"
              | "package"
              | "palette"
              | "pause"
              | "pencil"
              | "pencil_lines"
              | "permissions_limited"
              | "person"
              | "pin"
              | "pinmap"
              | "pivot_table"
              | "play"
              | "play_outlined"
              | "popover"
              | "popular"
              | "pulse"
              | "receipt"
              | "recents"
              | "share"
              | "send"
              | "smile"
              | "split"
              | "sql"
              | "subscription"
              | "straight"
              | "stepped"
              | "sticky_note"
              | "sort"
              | "sort_arrows"
              | "sum"
              | "sync"
              | "synced_collection"
              | "quote"
              | "redo"
              | "return"
              | "reference"
              | "refresh"
              | "refresh_downstream"
              | "repository"
              | "rocket"
              | "ruler"
              | "schema"
              | "search"
              | "section"
              | "segment"
              | "shield"
              | "shield_outline"
              | "sidebar_closed"
              | "sidebar_open"
              | "slack"
              | "slack_colorized"
              | "snail"
              | "snippet"
              | "sparkles"
              | "star_filled"
              | "star"
              | "stop"
              | "store"
              | "sun"
              | "t-shirt"
              | "tab"
              | "table2"
              | "text_bold"
              | "text_italic"
              | "text_strike"
              | "thumbs_down"
              | "thumbs_up"
              | "time_history"
              | "trash"
              | "trash_filled"
              | "triangle_left"
              | "triangle_right"
              | "unarchive"
              | "undo"
              | "unknown"
              | "unpin"
              | "unsubscribe"
              | "upload"
              | "variable"
              | "verified"
              | "official_collection"
              | "ordered_list"
              | "verified_filled"
              | "view_archive"
              | "warning"
              | "warning_round_filled"
              | "warning_triangle_filled"
              | "webhook"
              | "10k"
              | "1m"
              | "zap"
              | "zoom_in"
              | "zoom_out"
              | "cake"
              | "external"
              | "table_spaced"
              | "beaker"
              | "test_tube"
              | "eye_filled"

          Settings

          +
          Embedded analytics SDK API
            Preparing search index...

            Type Alias IconName

            IconName:
                | "string"
                | "number"
                | "function"
                | "collection"
                | "dashboard"
                | "question"
                | "model"
                | "archive"
                | "table"
                | "bar"
                | "line"
                | "pie"
                | "scalar"
                | "area"
                | "smartscalar"
                | "gauge"
                | "progress"
                | "funnel"
                | "waterfall"
                | "sankey"
                | "list"
                | "revert"
                | "add"
                | "add_column"
                | "add_data"
                | "add_folder"
                | "add_list"
                | "add_row"
                | "add_to_dash"
                | "add_comment"
                | "ai"
                | "alert"
                | "alert_filled"
                | "alert_confirm"
                | "attachment"
                | "arrow_up"
                | "arrow_down"
                | "arrow_left"
                | "arrow_left_to_line"
                | "arrow_right"
                | "arrow_split"
                | "audit"
                | "badge"
                | "ban"
                | "bell"
                | "birthday"
                | "book_open"
                | "bookmark"
                | "bookmark_filled"
                | "bolt"
                | "bolt_filled"
                | "breakout"
                | "bubble"
                | "burger"
                | "calendar"
                | "camera"
                | "check"
                | "check_filled"
                | "code_block"
                | "chevrondown"
                | "chevronleft"
                | "chevronright"
                | "chevronup"
                | "click"
                | "clipboard"
                | "clock"
                | "clone"
                | "close"
                | "cloud"
                | "cloud_filled"
                | "collection2"
                | "compare"
                | "combine"
                | "company"
                | "comment"
                | "currency"
                | "connections"
                | "contract"
                | "copy"
                | "curved"
                | "database"
                | "data_studio"
                | "dash"
                | "curve"
                | "document"
                | "download"
                | "dyno"
                | "edit_document"
                | "edit_document_outlined"
                | "ellipsis"
                | "embed"
                | "embed_interactive"
                | "embed_modular"
                | "embed_static"
                | "empty"
                | "enter_or_return"
                | "expand"
                | "expand_arrow"
                | "extract"
                | "eye"
                | "eye_crossed_out"
                | "eye_outline"
                | "factory"
                | "field"
                | "fields"
                | "filter"
                | "filter_plus"
                | "bug"
                | "format_code"
                | "formula"
                | "funnel_outline"
                | "folder"
                | "folder_filled"
                | "gear"
                | "gear_settings_filled"
                | "gem"
                | "globe"
                | "git_branch"
                | "grabber"
                | "grid"
                | "group"
                | "google"
                | "google_drive"
                | "google_sheet"
                | "history"
                | "home"
                | "horizontal_bar"
                | "hourglass"
                | "info"
                | "info_outline"
                | "insight"
                | "int"
                | "io"
                | "join_full_outer"
                | "join_inner"
                | "join_left_outer"
                | "join_right_outer"
                | "index"
                | "key"
                | "label"
                | "ldap"
                | "learn"
                | "lightbulb"
                | "link"
                | "lines"
                | "lineandbar"
                | "line_style_dashed"
                | "line_style_dotted"
                | "line_style_solid"
                | "location"
                | "lock"
                | "lock_filled"
                | "mail"
                | "mail_filled"
                | "medallion"
                | "message_circle"
                | "metabot"
                | "metabot_sad"
                | "metric"
                | "model_with_badge"
                | "moon"
                | "move"
                | "move_card"
                | "network"
                | "new_folder"
                | "notebook"
                | "octagon_alert"
                | "package"
                | "palette"
                | "pause"
                | "pencil"
                | "pencil_lines"
                | "permissions_limited"
                | "person"
                | "pin"
                | "pinmap"
                | "pivot_table"
                | "play"
                | "play_outlined"
                | "popover"
                | "popular"
                | "pulse"
                | "receipt"
                | "recents"
                | "share"
                | "send"
                | "settings"
                | "smile"
                | "split"
                | "sql"
                | "subscription"
                | "straight"
                | "stepped"
                | "sticky_note"
                | "sort"
                | "sort_arrows"
                | "sum"
                | "sync"
                | "synced_collection"
                | "transform"
                | "quote"
                | "redo"
                | "return"
                | "reference"
                | "refresh"
                | "refresh_downstream"
                | "repository"
                | "rocket"
                | "ruler"
                | "schema"
                | "search"
                | "section"
                | "segment"
                | "shield"
                | "shield_outline"
                | "sidebar_closed"
                | "sidebar_open"
                | "slack"
                | "slack_colorized"
                | "snail"
                | "snippet"
                | "sparkles"
                | "star_filled"
                | "star"
                | "stop"
                | "store"
                | "sun"
                | "t-shirt"
                | "tab"
                | "table2"
                | "text_bold"
                | "text_italic"
                | "text_strike"
                | "thumbs_down"
                | "thumbs_up"
                | "time_history"
                | "trash"
                | "trash_filled"
                | "triangle_left"
                | "triangle_right"
                | "unarchive"
                | "undo"
                | "unknown"
                | "unpin"
                | "unsubscribe"
                | "upload"
                | "variable"
                | "verified"
                | "official_collection"
                | "ordered_list"
                | "verified_filled"
                | "verified_round"
                | "view_archive"
                | "warning"
                | "warning_round_filled"
                | "warning_triangle_filled"
                | "webhook"
                | "10k"
                | "1m"
                | "zap"
                | "zoom_in"
                | "zoom_out"
                | "cake"
                | "external"
                | "table_spaced"
                | "beaker"
                | "test_tube"
                | "eye_filled"

            Settings

            \ No newline at end of file diff --git a/_site/docs/master/embedding/sdk/api/MetabaseCollectionItem.html b/_site/docs/master/embedding/sdk/api/MetabaseCollectionItem.html index abad2abdb..48c622be2 100644 --- a/_site/docs/master/embedding/sdk/api/MetabaseCollectionItem.html +++ b/_site/docs/master/embedding/sdk/api/MetabaseCollectionItem.html @@ -24,7 +24,7 @@
            Embedded analytics SDK API
              Preparing search index...

              Type Alias MetabaseCollectionItem

              The CollectionItem entity

              -
              type MetabaseCollectionItem = {
                  description: string | null;
                  entity_id?: SdkEntityId;
                  id: SdkCollectionId;
                  is_remote_synced?: boolean;
                  "last-edit-info"?: {
                      email: string;
                      first_name: string;
                      id: SdkUserId;
                      last_name: string;
                      timestamp: string;
                  };
                  model: string;
                  name: string;
                  type?: | "instance-analytics"
                  | "trash"
                  | "model"
                  | "question"
                  | "metric"
                  | null;
              }
              Index

              Properties

              description +
              type MetabaseCollectionItem = {
                  description: string | null;
                  entity_id?: SdkEntityId;
                  id: SdkCollectionId;
                  is_remote_synced?: boolean;
                  "last-edit-info"?: {
                      email: string;
                      first_name: string | null;
                      id: SdkUserId;
                      last_name: string | null;
                      timestamp: string;
                  };
                  model: string;
                  name: string;
                  type?: | "instance-analytics"
                  | "trash"
                  | "remote-synced"
                  | "library"
                  | "library-models"
                  | "library-metrics"
                  | "model"
                  | "question"
                  | "metric"
                  | null;
              }
              Index

              Properties

              description entity_id? id is_remote_synced? @@ -32,6 +32,6 @@ model name type? -

              Properties

              description: string | null
              entity_id?: SdkEntityId
              id: SdkCollectionId
              is_remote_synced?: boolean
              "last-edit-info"?: {
                  email: string;
                  first_name: string;
                  id: SdkUserId;
                  last_name: string;
                  timestamp: string;
              }
              model: string
              name: string
              type?: "instance-analytics" | "trash" | "model" | "question" | "metric" | null

              Settings

              On This Page

              Properties

              +

              Properties

              description: string | null
              entity_id?: SdkEntityId
              id: SdkCollectionId
              is_remote_synced?: boolean
              "last-edit-info"?: {
                  email: string;
                  first_name: string | null;
                  id: SdkUserId;
                  last_name: string | null;
                  timestamp: string;
              }
              model: string
              name: string
              type?:
                  | "instance-analytics"
                  | "trash"
                  | "remote-synced"
                  | "library"
                  | "library-models"
                  | "library-metrics"
                  | "model"
                  | "question"
                  | "metric"
                  | null

              Settings

              On This Page

              Properties
              \ No newline at end of file diff --git a/_site/docs/master/installation-and-operation/commands.html b/_site/docs/master/installation-and-operation/commands.html index 6cf2b91e3..2688a38b3 100644 --- a/_site/docs/master/installation-and-operation/commands.html +++ b/_site/docs/master/installation-and-operation/commands.html @@ -5452,7 +5452,7 @@

              Metabase CLI

              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