Skip to content
Snippets Groups Projects
Unverified Commit b337f510 authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

docs - frontmatter (#23272)

parent 5253f8cb
No related branches found
No related tags found
No related merge requests found
Showing
with 148 additions and 4 deletions
---
title: Supported browsers
---
# Supported browsers
We try our best to make sure Metabase works in as many browsers as possible, but as this is the Internet, there may be little quirks from time to time in different settings. We believe Metabase works on these versions of these browsers and will attempt to fix specific bugs if any are found:
......@@ -9,4 +13,4 @@ We try our best to make sure Metabase works in as many browsers as possible, but
Metabase may run perfectly well on older versions of these browsers or on specific browsers not listed above, but your mileage may vary. In particular, we ended support for IE11 in Metabase 0.40: it mostly still works, but you may see some unexpected behavior.
We recommend you use the most up-to-date browser you can.
We recommend you use the most up-to-date browser you can.
\ No newline at end of file
---
title: "Activity"
summary: "API endpoints for Activity."
---
# Activity
API endpoints for Activity.
- [GET /api/activity/](#get-apiactivity)
- [GET /api/activity/popular_items](#get-apiactivitypopular_items)
- [GET /api/activity/recent_views](#get-apiactivityrecent_views)
......
---
title: "Alert"
summary: "/api/alert endpoints."
---
# Alert
/api/alert endpoints.
......
---
title: "Automagic dashboards"
summary: "API endpoints for Automagic dashboards."
---
# Automagic dashboards
API endpoints for Automagic dashboards.
- [GET /api/automagic-dashboards/:entity/:entity-id-or-query](#get-apiautomagic-dashboardsentityentity-id-or-query)
- [GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query](#get-apiautomagic-dashboardsentityentity-id-or-querycellcell-query)
- [GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query/compare/:comparison-entity/:comparison-entity-id-or-query](#get-apiautomagic-dashboardsentityentity-id-or-querycellcell-querycomparecomparison-entitycomparison-entity-id-or-query)
......
---
title: "Bookmark"
summary: "Handle creating bookmarks for the user. Bookmarks are in three tables and should be thought of as a tuple of (model,
model-id) rather than a row in a table with an id. The DELETE takes the model and id because DELETE's do not
necessarily support request bodies. The POST is therefore shaped in this same manner. Since there are three
underlying tables the id on the actual bookmark itself is not unique among 'bookmarks' and is not a good
identifier for using in the API."
---
# Bookmark
Handle creating bookmarks for the user. Bookmarks are in three tables and should be thought of as a tuple of (model,
model-id) rather than a row in a table with an id. The DELETE takes the model and id because DELETE's do not
necessarily support request bodies. The POST is therefore shaped in this same manner. Since there are three
underlying tables the id on the actual bookmark itself is not unique among "bookmarks" and is not a good
underlying tables the id on the actual bookmark itself is not unique among 'bookmarks' and is not a good
identifier for using in the API.
- [DELETE /api/bookmark/:model/:id](#delete-apibookmarkmodelid)
......
---
title: "Card"
summary: "/api/card endpoints."
---
# Card
/api/card endpoints.
......@@ -98,6 +103,8 @@ Create a new `Card`.
* **`visualization_settings`** value must be a map.
* **`parameters`** value may be nil, or if non-nil, value must be an array. Each parameter must be a map with String :id key
* **`description`** value may be nil, or if non-nil, value must be a non-blank string.
* **`collection_position`** value may be nil, or if non-nil, value must be an integer greater than zero.
......@@ -112,6 +119,8 @@ Create a new `Card`.
* **`dataset_query`**
* **`parameter_mappings`** value may be nil, or if non-nil, value must be an array. Each parameter mapping must be a String :parameter_id key
* **`display`** value must be a non-blank string.
## `POST /api/card/:card-id/persist`
......@@ -228,6 +237,8 @@ Update a `Card`.
* **`visualization_settings`** value may be nil, or if non-nil, value must be a map.
* **`parameters`** value may be nil, or if non-nil, value must be an array. Each parameter must be a map with String :id key
* **`dataset`** value may be nil, or if non-nil, value must be a boolean.
* **`description`** value may be nil, or if non-nil, value must be a string.
......
---
title: "Collection"
summary: "`/api/collection` endpoints. By default, these endpoints operate on Collections in the 'default' namespace, which is
the one that has things like Dashboards and Cards. Other namespaces of Collections exist as well, such as the
`:snippet` namespace, (called 'Snippet folders' in the UI). These namespaces are completely independent hierarchies.
To use these endpoints for other Collections namespaces, you can pass the `?namespace=` parameter (e.g.
`?namespace=snippet`)."
---
# Collection
`/api/collection` endpoints. By default, these endpoints operate on Collections in the 'default' namespace, which is
......
---
title: "Dashboard"
summary: "/api/dashboard endpoints."
---
# Dashboard
/api/dashboard endpoints.
......@@ -175,7 +180,7 @@ Create a new Dashboard.
* **`description`** value may be nil, or if non-nil, value must be a string.
* **`parameters`** value must be an array. Each value must be a map.
* **`parameters`** value may be nil, or if non-nil, value must be an array. Each parameter must be a map with String :id key
* **`cache_ttl`** value may be nil, or if non-nil, value must be an integer greater than zero.
......@@ -317,7 +322,7 @@ Update a Dashboard.
### PARAMS:
* **`parameters`** value may be nil, or if non-nil, value must be an array. Each value must be a map.
* **`parameters`** value may be nil, or if non-nil, value must be an array. Each parameter must be a map with String :id key
* **`points_of_interest`** value may be nil, or if non-nil, value must be a string.
......
---
title: "Database"
summary: "/api/database endpoints."
---
# Database
/api/database endpoints.
......@@ -321,6 +326,8 @@ Update a `Database`.
* **`name`** value may be nil, or if non-nil, value must be a non-blank string.
* **`settings`** value may be nil, or if non-nil, value must be a map.
* **`caveats`** value may be nil, or if non-nil, value must be a string.
* **`is_full_sync`**
......
---
title: "Dataset"
summary: "/api/dataset endpoints."
---
# Dataset
/api/dataset endpoints.
......
---
title: "Advanced permissions application"
summary: "`/advanced-permisisons/application` Routes.
Implements the Permissions routes needed for application permission - a class of permissions that control access to features
like access Setting pages, access monitoring tools ... etc."
---
# Advanced permissions application
`/advanced-permisisons/application` Routes.
......
---
title: "Audit app user"
summary: "`/api/ee/audit-app/user` endpoints. These only work if you have a premium token with the `:audit-app` feature."
---
# Audit app user
`/api/ee/audit-app/user` endpoints. These only work if you have a premium token with the `:audit-app` feature.
......
---
title: "Content management review"
summary: "API endpoints for Content management review."
---
# Content management review
API endpoints for Content management review.
- [POST /api/ee/content-management/review/](#post-apieecontent-managementreview)
## `POST /api/ee/content-management/review/`
......
---
title: "Sandbox GTAP"
summary: "`/api/mt/gtap` endpoints, for CRUD operations and the like on GTAPs (Group Table Access Policies)."
---
# Sandbox GTAP
`/api/mt/gtap` endpoints, for CRUD operations and the like on GTAPs (Group Table Access Policies).
......
---
title: "Sandbox table"
summary: "API endpoints for Sandbox table."
---
# Sandbox table
API endpoints for Sandbox table.
- [GET /api/ee/sandbox/table/:id/query_metadata](#get-apieesandboxtableidquery_metadata)
## `GET /api/ee/sandbox/table/:id/query_metadata`
......
---
title: "Sandbox user"
summary: "Endpoint(s)for setting user attributes."
---
# Sandbox user
Endpoint(s)for setting user attributes.
......
---
title: "SSO"
summary: "`/auth/sso` Routes.
Implements the SSO routes needed for SAML and JWT. This namespace primarily provides hooks for those two backends so
we can have a uniform interface both via the API and code."
---
# SSO
`/auth/sso` Routes.
......
---
title: "Email"
summary: "/api/email endpoints."
---
# Email
/api/email endpoints.
......
---
title: "Embed"
summary: "Various endpoints that use [JSON web tokens](https://jwt.io/introduction/) to fetch Cards and Dashboards.
The endpoints are the same as the ones in `api/public/`, and differ only in the way they are authorized.
To use these endpoints:
1. Set the `embedding-secret-key` Setting to a hexadecimal-encoded 32-byte sequence (i.e., a 64-character string).
You can use `/api/util/random_token` to get a cryptographically-secure value for this.
2. Sign/base-64 encode a JSON Web Token using the secret key and pass it as the relevant part of the URL path
to the various endpoints here.
Tokens can have the following fields:
{:resource {:question <card-id>
:dashboard <dashboard-id>}
:params <params>}."
---
# Embed
Various endpoints that use [JSON web tokens](https://jwt.io/introduction/) to fetch Cards and Dashboards.
......
---
title: "Field"
summary: "API endpoints for Field."
---
# Field
API endpoints for Field.
- [DELETE /api/field/:id/dimension](#delete-apifieldiddimension)
- [GET /api/field/:id](#get-apifieldid)
- [GET /api/field/:id/related](#get-apifieldidrelated)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment