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) (#66300)

github-automation-metabase13db04d7a09a
diff --git a/docs/api.json b/docs/api.json
index eb1c8a0be10..76ac37be7f2 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -1137,6 +1137,45 @@
"$ref" : "#/components/schemas/metabase-enterprise.action-v2.api.api-action-expression"
} ]
},
+ "metabase-enterprise.data-studio.api.table.data-authorities" : {
+ "type" : "string",
+ "enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
+ },
+ "metabase-enterprise.data-studio.api.table.data-layers" : {
+ "type" : "string",
+ "enum" : [ "copper", "bronze", "gold", "silver" ]
+ },
+ "metabase-enterprise.data-studio.api.table.data-sources" : {
+ "type" : "string",
+ "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
+ },
+ "metabase-enterprise.data-studio.api.table.table-selectors" : {
+ "type" : "object",
+ "properties" : {
+ "database_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "schema_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ }
+ },
"metabase-enterprise.dependencies.api.card-body" : {
"description" : "Schema for an instance of a `:model/Card` (everything is optional to support updates).",
"type" : "object",
@@ -3106,6 +3145,9 @@
"metabase-enterprise.metabot-v3.tools.api.table-result" : {
"type" : "object",
"properties" : {
+ "database_engine" : {
+ "type" : "string"
+ },
"id" : {
"type" : "integer"
},
@@ -3144,7 +3186,7 @@
"type" : "string"
}
},
- "required" : [ "id", "type", "name", "display_name", "database_id", "fields" ]
+ "required" : [ "id", "type", "name", "display_name", "database_id", "database_engine", "fields" ]
},
"metabase-enterprise.metabot-v3.tools.api.temporal-extraction-filter" : {
"allOf" : [ {
@@ -9400,6 +9442,14 @@
"type" : "string",
"enum" : [ "computed", "authoritative", "unconfigured", "ingested" ]
},
+ "metabase.warehouse-schema-rest.api.table.data-layers" : {
+ "type" : "string",
+ "enum" : [ "copper", "bronze", "gold", "silver" ]
+ },
+ "metabase.warehouse-schema-rest.api.table.data-sources" : {
+ "type" : "string",
+ "enum" : [ "source-data", "transform", "unknown", "ingested", "metabase-transform", "upload" ]
+ },
"metabase.warehouses-rest.api.available-settings" : {
"type" : "object",
"additionalProperties" : {
@@ -12673,7 +12723,7 @@
"/api/collection/root/items" : {
"get" : {
"summary" : "GET /api/collection/root/items",
- "description" : "Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collection\n doesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no\n `collection_id` exist. It does, however, have its own set of Permissions.\n\n This endpoint will actually show objects with no `collection_id` for Users that have Root Collection\n permissions, but for people without Root Collection perms, we'll just show the objects that have an effective\n location of `/`.\n\n This endpoint is intended to power a 'Root Folder View' for the Current User, so regardless you'll see all the\n top-level objects you're allowed to access.\n\n By default, this will show the 'normal' Collections namespace; to view a different Collections namespace, such as\n `snippets`, you can pass the `?namespace=` parameter.\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
+ "description" : "Fetch objects that the current user should see at their root level. As mentioned elsewhere, the 'Root' Collection\n doesn't actually exist as a row in the application DB: it's simply a virtual Collection where things with no\n `collection_id` exist. It does, however, have its own set of Permissions.\n\n This endpoint will actually show objects with no `collection_id` for Users that have Root Collection\n permissions, but for people without Root Collection perms, we'll just show the objects that have an effective\n location of `/`.\n\n This endpoint is intended to power a 'Root Folder View' for the Current User, so regardless you'll see all the\n top-level objects you're allowed to access.\n\n By default, this will show the 'normal' Collections namespace; to view a different Collections namespace, such as\n `snippets`, you can pass the `?namespace=` parameter.\n\n By default, library collections are excluded from the results; to include them, pass `?include_library=true`.\n\n Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is\n changed, that should too.",
"parameters" : [ {
"in" : "query",
"name" : "models",
@@ -12717,6 +12767,14 @@
"type" : "string",
"minLength" : 1
}
+ }, {
+ "in" : "query",
+ "name" : "include_library",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean",
+ "default" : false
+ }
}, {
"in" : "query",
"name" : "pinned_state",
@@ -12856,6 +12914,14 @@
"type" : "boolean",
"default" : false
}
+ }, {
+ "in" : "query",
+ "name" : "include-library",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean",
+ "default" : false
+ }
}, {
"in" : "query",
"name" : "namespace",
@@ -16724,6 +16790,222 @@
"tags" : [ "/api/ee/content-translation" ]
}
},
+ "/api/ee/data-studio/table/discard-values" : {
+ "post" : {
+ "summary" : "POST /api/ee/data-studio/table/discard-values",
+ "description" : "Batch version of /table/:id/discard_values. Takes an abstract table selection as /table/edit does.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/data-studio/table" ]
+ }
+ },
+ "/api/ee/data-studio/table/edit" : {
+ "post" : {
+ "summary" : "POST /api/ee/data-studio/table/edit",
+ "description" : "Bulk updating tables.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data_authority" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-authorities"
+ },
+ "data_layer" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-layers"
+ },
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "owner_email" : {
+ "type" : "string"
+ },
+ "owner_user_id" : {
+ "type" : "integer"
+ },
+ "data_source" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.data-sources"
+ },
+ "schema_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "entity_type" : {
+ "type" : "string"
+ },
+ "database_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ }
+ },
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/data-studio/table" ]
+ }
+ },
+ "/api/ee/data-studio/table/publish-model" : {
+ "post" : {
+ "summary" : "POST /api/ee/data-studio/table/publish-model",
+ "description" : "Create a model for each of selected tables",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "database_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "schema_ids" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "table_ids" : {
+ "type" : "array",
+ "items" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "target_collection_id" : {
+ "anyOf" : [ {
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "const" : "library"
+ } ]
+ }
+ },
+ "required" : [ ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/data-studio/table" ]
+ }
+ },
+ "/api/ee/data-studio/table/rescan-values" : {
+ "post" : {
+ "summary" : "POST /api/ee/data-studio/table/rescan-values",
+ "description" : "Batch version of /table/:id/rescan_values. Takes an abstract table selection as /table/edit does.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/data-studio/table" ]
+ }
+ },
+ "/api/ee/data-studio/table/sync-schema" : {
+ "post" : {
+ "summary" : "POST /api/ee/data-studio/table/sync-schema",
+ "description" : "Batch version of /table/:id/sync_schema. Takes an abstract table selection as /table/edit does.\n - Currently checks policy before returning (so you might receive a 4xx on e.g. AuthZ policy failure)\n - The sync itself is however, asyncronous. This call may return before all tables synced.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.data-studio.api.table.table-selectors"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/data-studio/table" ]
+ }
+ },
"/api/ee/database-replication/connection/{database-id}" : {
"post" : {
"summary" : "POST /api/ee/database-replication/connection/{database-id}",
@@ -17886,6 +18168,61 @@
"tags" : [ "/api/ee/gsheets" ]
}
},
+ "/api/ee/library/" : {
+ "post" : {
+ "summary" : "POST /api/ee/library/",
+ "description" : "Creates the Library if it doesn't exist. Returns the created collection.\n\n Requires superuser permissions.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/library" ]
+ },
+ "get" : {
+ "summary" : "GET /api/ee/library/",
+ "description" : "Get the Library. If no library exists, it doesn't fail but returns an empty response.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/library" ]
+ }
+ },
+ "/api/ee/library/tree" : {
+ "get" : {
+ "summary" : "GET /api/ee/library/tree",
+ "description" : "This matches /api/collection/tree but only returns the library collection.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response"
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/library" ]
+ }
+ },
"/api/ee/logs/query_execution/{yyyy-mm}" : {
"get" : {
"summary" : "GET /api/ee/logs/query_execution/{yyyy-mm}",
@@ -28049,6 +28386,15 @@
"type" : "boolean",
"default" : false
}
+ }, {
+ "in" : "query",
+ "name" : "collection",
+ "required" : false,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
}, {
"in" : "query",
"name" : "table_db_id",
@@ -29059,7 +29405,63 @@
"get" : {
"summary" : "GET /api/table/",
"description" : "Get all `Tables`.",
- "parameters" : [ ],
+ "parameters" : [ {
+ "in" : "query",
+ "name" : "term",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "visibility-type",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "data-layer",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-layers"
+ }
+ }, {
+ "in" : "query",
+ "name" : "data-source",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-sources"
+ }
+ }, {
+ "in" : "query",
+ "name" : "owner-user-id",
+ "required" : false,
+ "schema" : {
+ "type" : "integer"
+ }
+ }, {
+ "in" : "query",
+ "name" : "owner-email",
+ "required" : false,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "orphan-only",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "in" : "query",
+ "name" : "unused-only",
+ "required" : false,
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
"responses" : {
"2XX" : {
"description" : "Successful response"
@@ -29075,7 +29477,7 @@
},
"put" : {
"summary" : "PUT /api/table/",
- "description" : "Update all `Table` in `ids`.",
+ "description" : "Update all `Table` in `ids`.\n\n Deprecated, should use PUT /table/edit from now on.",
"parameters" : [ ],
"responses" : {
"2XX" : {
@@ -29104,9 +29506,18 @@
"data_authority" : {
"$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-authority-write"
},
+ "data_layer" : {
+ "type" : "string"
+ },
"show_in_getting_started" : {
"type" : "boolean"
},
+ "owner_email" : {
+ "type" : "string"
+ },
+ "owner_user_id" : {
+ "type" : "integer"
+ },
"ids" : {
"type" : "array",
"items" : {
@@ -29119,6 +29530,9 @@
"type" : "string",
"minLength" : 1
},
+ "data_source" : {
+ "type" : "string"
+ },
"caveats" : {
"type" : "string"
},
@@ -29267,13 +29681,25 @@
"data_authority" : {
"$ref" : "#/components/schemas/metabase.warehouse-schema-rest.api.table.data-authority-write"
},
+ "data_layer" : {
+ "type" : "string"
+ },
"show_in_getting_started" : {
"type" : "boolean"
},
+ "owner_email" : {
+ "type" : "string"
+ },
+ "owner_user_id" : {
+ "type" : "integer"
+ },
"display_name" : {
"type" : "string",
"minLength" : 1
},
+ "data_source" : {
+ "type" : "string"
+ },
"caveats" : {
"type" : "string"
},