Skip to content

Commit 388acfd

Browse files
github-automation-metabaseMetabase Docs bot
andauthored
[auto] adding content to master->master (#749)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent 5c03e92 commit 388acfd

File tree

19 files changed

+333
-35
lines changed

19 files changed

+333
-35
lines changed

_docs/master/api.html

Lines changed: 89 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16347,6 +16347,94 @@
1634716347
"tags" : [ "/api/ee/dependencies" ]
1634816348
}
1634916349
},
16350+
"/api/ee/dependencies/graph" : {
16351+
"get" : {
16352+
"summary" : "GET /api/ee/dependencies/graph",
16353+
"description" : "TODO: This endpoint is supposed to take an :id and :type of an entity (currently :table, :card, :snippet,\n or :transform) and return the entity with all its upstream and downstream dependencies that should be fetched\n recursively. :edges match our :model/Dependency format. Each node in :nodes has :id, :type, and :data, and :data\n depends on the node type. For :table, there should be :display_name. For :card, there should be :name\n and :type. For :snippet -> :name. For :transform -> :name.",
16354+
"parameters" : [ {
16355+
"in" : "query",
16356+
"name" : "id",
16357+
"required" : false,
16358+
"schema" : {
16359+
"type" : "integer",
16360+
"minimum" : 1
16361+
},
16362+
"description" : "value must be an integer greater than zero."
16363+
}, {
16364+
"in" : "query",
16365+
"name" : "type",
16366+
"required" : false,
16367+
"schema" : {
16368+
"type" : "string",
16369+
"enum" : [ "table", "card", "snippet", "transform" ]
16370+
}
16371+
} ],
16372+
"responses" : {
16373+
"2XX" : {
16374+
"description" : "Successful response"
16375+
},
16376+
"4XX" : {
16377+
"description" : "Client error response"
16378+
},
16379+
"5XX" : {
16380+
"description" : "Server error response"
16381+
}
16382+
},
16383+
"tags" : [ "/api/ee/dependencies" ]
16384+
}
16385+
},
16386+
"/api/ee/dependencies/graph/dependents" : {
16387+
"get" : {
16388+
"summary" : "GET /api/ee/dependencies/graph/dependents",
16389+
"description" : "TODO: This endpoint is supposed to take an :id and :type of an entity (currently :table, :card, :snippet,\n or :transform) and return the entity with all its upstream and downstream dependencies that should be fetched\n recursively. :edges match our :model/Dependency format. Each node in :nodes has :id, :type, and :data, and :data\n depends on the node type. For :table, there should be :display_name. For :card, there should be :name\n and :type. For :snippet -> :name. For :transform -> :name.",
16390+
"parameters" : [ {
16391+
"in" : "query",
16392+
"name" : "id",
16393+
"required" : true,
16394+
"schema" : {
16395+
"type" : "integer",
16396+
"minimum" : 1
16397+
},
16398+
"description" : "value must be an integer greater than zero."
16399+
}, {
16400+
"in" : "query",
16401+
"name" : "type",
16402+
"required" : true,
16403+
"schema" : {
16404+
"type" : "string",
16405+
"enum" : [ "table", "card", "snippet", "transform" ]
16406+
}
16407+
}, {
16408+
"in" : "query",
16409+
"name" : "dependent_type",
16410+
"required" : true,
16411+
"schema" : {
16412+
"type" : "string",
16413+
"enum" : [ "table", "card", "snippet", "transform" ]
16414+
}
16415+
}, {
16416+
"in" : "query",
16417+
"name" : "dependent_card_type",
16418+
"required" : false,
16419+
"schema" : {
16420+
"type" : "string",
16421+
"enum" : [ "question", "model", "metric" ]
16422+
}
16423+
} ],
16424+
"responses" : {
16425+
"2XX" : {
16426+
"description" : "Successful response"
16427+
},
16428+
"4XX" : {
16429+
"description" : "Client error response"
16430+
},
16431+
"5XX" : {
16432+
"description" : "Server error response"
16433+
}
16434+
},
16435+
"tags" : [ "/api/ee/dependencies" ]
16436+
}
16437+
},
1635016438
"/api/ee/document/" : {
1635116439
"get" : {
1635216440
"summary" : "GET /api/ee/document/",
@@ -25849,7 +25937,7 @@
2584925937
"type" : "array",
2585025938
"items" : {
2585125939
"type" : "string",
25852-
"enum" : [ "dashboard", "table", "dataset", "segment", "collection", "document", "database", "action", "indexed-entity", "metric", "card" ]
25940+
"enum" : [ "dashboard", "table", "dataset", "segment", "collection", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
2585325941
}
2585425942
}
2585525943
}, {

_docs/master/developers-guide/driver-changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ layout: new-docs
5555
you can pass to [[metabase.lib.core/order-by]] -- for example a Lib `:metadata/column` or an [MBQL 5]
5656
`metabase.driver-api.core/order-by-clause`.
5757

58+
- `metabase.driver-api.core/nest-query` no longer automatically calls `metabase.driver-api.core/add-alias-info` on its
59+
results, but it also no longer expect its input to have this information. If you were using both of these tools in
60+
your driver, make change the order in which the are applied so `nest-query` happens first, followed by
61+
`add-alias-info`. Note that drivers deriving from `:sql` do not need to make any changes, since this is done by the
62+
base `:sql` driver implementation.
63+
5864
## Metabase 0.56.3
5965

6066
- Added the driver multi-method `driver/describe-database*` that drivers should now implement instead of `driver/describe-database`.

_docs/master/embedding/embedded-analytics-js.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Currently you can choose to embed:
2929
- A question (chart). You can embed both questions built with the query builder and questions built with SQL.
3030
- Full graphical [query builder](../questions/query-builder/editor) to enable people to build their own charts and explorations.
3131
- A browser to navigate collections and open dashboards or questions.
32+
- [AI chat interface](./sdk/ai-chat).
3233

3334
## Quickstart
3435

@@ -50,10 +51,10 @@ You can also follow the setup guide directly in Metabase in **Admin settings > E
5051
2. Choose the _type_ of entity to embed:
5152

5253
- Dashboard
53-
- Question
54+
- Chart
5455
- Exploration (which will embed the Metabase query builder)
5556
- Browser
56-
- Metabot question
57+
- Metabot question (which will embed AI chat)
5758

5859
3. Next, select the entity you want to embed. For browser, pick the collection you want people to start from.
5960

@@ -365,7 +366,7 @@ To render a dashboard:
365366

366367
### Question
367368

368-
To render a question (chart).
369+
To render a question (chart):
369370

370371
```html
371372
<metabase-question question-id="1"></metabase-question>
@@ -386,9 +387,9 @@ To render a question (chart).
386387
- `is-save-enabled` (default is false)
387388
- `target-collection` - this is to enforce saving into a particular collection. Values: regular ID, entity ID, `"personal”`, `"root”`
388389

389-
- ### Browser
390+
### Browser
390391

391-
To render a collection browser so people can navigate a collection and open dashboards or questions.
392+
To render a collection browser so people can navigate a collection and open dashboards or questions:
392393

393394
```html
394395
<metabase-browser initial-collection="14" read-only="false"></metabase-browser>
@@ -402,6 +403,25 @@ To render a collection browser so people can navigate a collection and open dash
402403

403404
- `read-only` (default is true) – if true, people can interact with items (filter, summarize, drill-through) but cannot save. If false, they can create and edit items in the collection.
404405

406+
### Metabot
407+
408+
To render the AI chat interface:
409+
410+
```html
411+
<metabase-metabot></metabase-metabot>
412+
```
413+
414+
**Required parameters:**
415+
416+
None.
417+
418+
**Optional parameters:**
419+
420+
- `layout` (default is `auto`) – how should the browser position the visualization with respect to the chat interface. Possible values are:
421+
- `auto` (default): Metabot uses the `stacked` layout on mobile screens, and a `sidebar` layout on larger screens.
422+
- `stacked`: the question visualization stacks on top of the chat interface.
423+
- `sidebar`: the question visualization appears to the left of the chat interface, which is in the right sidebar.
424+
405425
## Embedding Metabase in a different domain
406426

407427
If you want to embed Metabase in another domain (say, if Metabase is hosted at `metabase.yourcompany.com`, but you want to embed Metabase at `yourcompany.github.io`), you can tell Metabase to set the session cookie's SameSite value to "none".

_docs/master/embedding/sdk/ai-chat.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ You can check out a [demo of the AI chat component](https://embedded-analytics-s
3232
{% include_file "{{ dirname }}/snippets/questions/ai-question.tsx" %}
3333
```
3434

35+
## Props
36+
37+
{% include_file "{{ dirname }}/api/snippets/MetabotQuestionProps.md" snippet="properties" %}
38+
3539
## API reference
3640

3741
- [Component](./api/MetabotQuestion)

_docs/master/embedding/sdk/api/IconName.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)