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

update api docs (#38736)

parent adb3ea3b
Branches
Tags
No related merge requests found
......@@ -27,12 +27,13 @@ Delete a Card. (DEPRECATED -- don't delete a Card anymore -- archive it instead.
## `GET /api/card/`
Get all the Cards. Option filter param `f` can be used to change the set of Cards that are returned; default is
`all`, but other options include `mine`, `bookmarked`, `database`, `table`, `using_model` and `archived`. See
corresponding implementation functions above for the specific behavior of each filterp option. :card_index.
`all`, but other options include `mine`, `bookmarked`, `database`, `table`, `using_model`, `using_metric`,
`using_segment`, and `archived`. See corresponding implementation functions above for the specific behavior of each
filterp option. :card_index.
### PARAMS:
* **`f`** nullable enum of archived, table, using_model, bookmarked, all, mine, database
* **`f`** nullable enum of archived, table, using_model, bookmarked, using_segment, all, mine, using_metric, database
* **`model_id`** nullable value must be an integer greater than zero.
......@@ -147,6 +148,8 @@ Create a new `Card`.
* **`name`** value must be a non-blank string.
* **`type`** nullable enum of model, question
* **`cache_ttl`** nullable value must be an integer greater than zero.
* **`dataset_query`** Value must be a map.
......@@ -299,6 +302,8 @@ Update a `Card`.
* **`name`** nullable value must be a non-blank string.
* **`type`** nullable enum of model, question
* **`embedding_params`** nullable value must be a valid embedding params map.
* **`cache_ttl`** nullable value must be an integer greater than zero.
......
......@@ -330,6 +330,8 @@ Update a Dashboard, and optionally the `dashcards` and `tabs` of a Dashboard. Th
* **`name`** nullable value must be a non-blank string.
* **`width`** nullable enum of fixed, full
* **`caveats`** nullable string
* **`embedding_params`** nullable value must be a valid embedding params map.
......
......@@ -17,6 +17,11 @@ Delete all Alert and DashboardSubscription subscriptions for a User (i.e., so th
* **`id`** value must be an integer greater than zero.
## `GET /api/ee/audit-app/user/audit-info`
Gets audit info for the current user if he has permissions to access the audit collection.
Otherwise return an empty map.
---
[<< Back to API index](../../api-documentation.md)
\ No newline at end of file
......@@ -94,7 +94,7 @@ Create a new `Pulse`.
* **`name`** value must be a non-blank string.
* **`cards`** one or more value must be a map with the following keys `(collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings)`, or value must be a map with the keys `id`, `include_csv`, `include_xls`, and `dashboard_card_id`.
* **`cards`** one or more value must be a map with the following keys `(collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings)`, or value must be a map with the keys `id`, `include_csv`, `include_xls`, and `dashboard_card_id`., or value must be a map with the keys `include_csv`, `include_xls`, and `dashboard_card_id`.
* **`channels`** one or more map
......@@ -116,7 +116,7 @@ Test send an unsaved pulse.
* **`name`** value must be a non-blank string.
* **`cards`** one or more value must be a map with the following keys `(collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings)`, or value must be a map with the keys `id`, `include_csv`, `include_xls`, and `dashboard_card_id`.
* **`cards`** one or more value must be a map with the following keys `(collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings)`, or value must be a map with the keys `id`, `include_csv`, `include_xls`, and `dashboard_card_id`., or value must be a map with the keys `include_csv`, `include_xls`, and `dashboard_card_id`.
* **`channels`** one or more map
......@@ -148,7 +148,7 @@ Update a Pulse with `id`.
* **`id`** value must be an integer greater than zero.
* **`cards`** nullable one or more value must be a map with the following keys `(collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings)`, or value must be a map with the keys `id`, `include_csv`, `include_xls`, and `dashboard_card_id`.
* **`cards`** nullable one or more value must be a map with the following keys `(collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings)`, or value must be a map with the keys `id`, `include_csv`, `include_xls`, and `dashboard_card_id`., or value must be a map with the keys `include_csv`, `include_xls`, and `dashboard_card_id`.
* **`pulse-updates`**
......
......@@ -18,7 +18,7 @@ Logout.
## `GET /api/session/password_reset_token_valid`
Check is a password reset token is valid and isn't expired.
Check if a password reset token is valid and isn't expired.
### PARAMS:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment