Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 89 additions & 1 deletion _docs/master/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -16347,6 +16347,94 @@
"tags" : [ "/api/ee/dependencies" ]
}
},
"/api/ee/dependencies/graph" : {
"get" : {
"summary" : "GET /api/ee/dependencies/graph",
"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.",
"parameters" : [ {
"in" : "query",
"name" : "id",
"required" : false,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
}, {
"in" : "query",
"name" : "type",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [ "table", "card", "snippet", "transform" ]
}
} ],
"responses" : {
"2XX" : {
"description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
},
"5XX" : {
"description" : "Server error response"
}
},
"tags" : [ "/api/ee/dependencies" ]
}
},
"/api/ee/dependencies/graph/dependents" : {
"get" : {
"summary" : "GET /api/ee/dependencies/graph/dependents",
"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.",
"parameters" : [ {
"in" : "query",
"name" : "id",
"required" : true,
"schema" : {
"type" : "integer",
"minimum" : 1
},
"description" : "value must be an integer greater than zero."
}, {
"in" : "query",
"name" : "type",
"required" : true,
"schema" : {
"type" : "string",
"enum" : [ "table", "card", "snippet", "transform" ]
}
}, {
"in" : "query",
"name" : "dependent_type",
"required" : true,
"schema" : {
"type" : "string",
"enum" : [ "table", "card", "snippet", "transform" ]
}
}, {
"in" : "query",
"name" : "dependent_card_type",
"required" : false,
"schema" : {
"type" : "string",
"enum" : [ "question", "model", "metric" ]
}
} ],
"responses" : {
"2XX" : {
"description" : "Successful response"
},
"4XX" : {
"description" : "Client error response"
},
"5XX" : {
"description" : "Server error response"
}
},
"tags" : [ "/api/ee/dependencies" ]
}
},
"/api/ee/document/" : {
"get" : {
"summary" : "GET /api/ee/document/",
Expand Down Expand Up @@ -25849,7 +25937,7 @@
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "dashboard", "table", "dataset", "segment", "collection", "document", "database", "action", "indexed-entity", "metric", "card" ]
"enum" : [ "dashboard", "table", "dataset", "segment", "collection", "transform", "document", "database", "action", "indexed-entity", "metric", "card" ]
}
}
}, {
Expand Down
6 changes: 6 additions & 0 deletions _docs/master/developers-guide/driver-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@ layout: new-docs
you can pass to [[metabase.lib.core/order-by]] -- for example a Lib `:metadata/column` or an [MBQL 5]
`metabase.driver-api.core/order-by-clause`.

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

## Metabase 0.56.3

- Added the driver multi-method `driver/describe-database*` that drivers should now implement instead of `driver/describe-database`.
Expand Down
30 changes: 25 additions & 5 deletions _docs/master/embedding/embedded-analytics-js.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Currently you can choose to embed:
- A question (chart). You can embed both questions built with the query builder and questions built with SQL.
- Full graphical [query builder](../questions/query-builder/editor) to enable people to build their own charts and explorations.
- A browser to navigate collections and open dashboards or questions.
- [AI chat interface](./sdk/ai-chat).

## Quickstart

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

- Dashboard
- Question
- Chart
- Exploration (which will embed the Metabase query builder)
- Browser
- Metabot question
- Metabot question (which will embed AI chat)

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

Expand Down Expand Up @@ -365,7 +366,7 @@ To render a dashboard:

### Question

To render a question (chart).
To render a question (chart):

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

- ### Browser
### Browser

To render a collection browser so people can navigate a collection and open dashboards or questions.
To render a collection browser so people can navigate a collection and open dashboards or questions:

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

- `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.

### Metabot

To render the AI chat interface:

```html
<metabase-metabot></metabase-metabot>
```

**Required parameters:**

None.

**Optional parameters:**

- `layout` (default is `auto`) – how should the browser position the visualization with respect to the chat interface. Possible values are:
- `auto` (default): Metabot uses the `stacked` layout on mobile screens, and a `sidebar` layout on larger screens.
- `stacked`: the question visualization stacks on top of the chat interface.
- `sidebar`: the question visualization appears to the left of the chat interface, which is in the right sidebar.

## Embedding Metabase in a different domain

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".
Expand Down
4 changes: 4 additions & 0 deletions _docs/master/embedding/sdk/ai-chat.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ You can check out a [demo of the AI chat component](https://embedded-analytics-s
{% include_file "{{ dirname }}/snippets/questions/ai-question.tsx" %}
```

## Props

{% include_file "{{ dirname }}/api/snippets/MetabotQuestionProps.md" snippet="properties" %}

## API reference

- [Component](./api/MetabotQuestion)
Expand Down
2 changes: 1 addition & 1 deletion _docs/master/embedding/sdk/api/IconName.html

Large diffs are not rendered by default.

Loading