updated docs

docs/api-documentation.md

@@ -19,6 +19,10 @@ clojure -M:ee:doc api-documentation
 
 Check out an introduction to the [Metabase API](https://www.metabase.com/learn/administration/metabase-api.html).
 
+## Live OpenAPI docs
+
+You can view live OpenAPI docs in your own running Metabase at `/api/docs`. So if your Metabase is at https://www.your-metabase.com you could view the API docs at https://www.your-metabase.com/api/docs.
+
 ## API keys
 
 Create keys to authenticate programmatic requests to your Metabase. See [API keys](./people-and-groups/api-keys.md).
@@ -44,6 +48,7 @@ _* indicates endpoints used for features available on [paid plans](https://www.m
 - [Bookmark](api/bookmark.md)
 - [Cache](api/cache.md)
 - [Card](api/card.md)
+- [Cards](api/cards.md)
 - [Channel](api/channel.md)
 - [Cloud migration](api/cloud-migration.md)
 - [Collection](api/collection.md)
@@ -93,4 +98,5 @@ _* indicates endpoints used for features available on [paid plans](https://www.m
 - [Timeline event](api/timeline-event.md)
 - [Upload management*](api/ee/upload-management.md)
 - [User](api/user.md)
+- [User key value](api/user-key-value.md)
 - [Util](api/util.md)

docs/api/action.md

@@ -6,6 +6,10 @@ summary: |
 
 # Action
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 `/api/action/` endpoints.
 
 ## `DELETE /api/action/:action-id`

docs/api/activity.md

@@ -6,6 +6,10 @@ summary: |
 
 # Activity
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Activity.
 
 ## `GET /api/activity/most_recently_viewed_dashboard`

docs/api/alert.md

@@ -8,6 +8,10 @@ summary: |
 
 # Alert
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/alert endpoints.
 
   Deprecated: will soon be migrated to notification APIs.

docs/api/api-key.md

@@ -6,6 +6,10 @@ summary: |
 
 # API key
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/api-key endpoints for CRUD management of API Keys.
 
 ## `DELETE /api/api-key/:id`

docs/api/automagic-dashboards.md

@@ -6,6 +6,10 @@ summary: |
 
 # Automagic dashboards
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Automagic dashboards.
 
 ## `GET /api/automagic-dashboards/:entity/:entity-id-or-query`

docs/api/bookmark.md

@@ -10,6 +10,10 @@ summary: |
 
 # Bookmark
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 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

docs/api/cache.md

@@ -6,6 +6,10 @@ summary: |
 
 # Cache
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Cache.
 
 ## `DELETE /api/cache/`

docs/api/card.md

@@ -6,6 +6,10 @@ summary: |
 
 # Card
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/card endpoints.
 
 ## `DELETE /api/card/:card-id/public_link`
@@ -79,6 +83,14 @@ Get `Card` with ID.
 
 -  **`context`** nullable enum of :collection.
 
+## `GET /api/card/:id/dashboards`
+
+Get a list of `{:name ... :id ...}` pairs for all the dashboards this card appears in.
+
+### PARAMS:
+
+-  **`id`** value must be an integer greater than zero.
+
 ## `GET /api/card/:id/query_metadata`
 
 Get all of the required query metadata for a card.
@@ -134,10 +146,14 @@ Create a new `Card`. Card `type` can be `question`, `metric`, or `model`.
 
 ### PARAMS:
 
+-  **`entity_id`** nullable value must be a non-blank string.
+
 -  **`visualization_settings`** Value must be a map.
 
 -  **`parameters`** nullable sequence of parameter must be a map with :id and :type keys.
 
+-  **`dashboard_id`** nullable value must be an integer greater than zero.
+
 -  **`description`** nullable value must be a non-blank string.
 
 -  **`collection_position`** nullable value must be an integer greater than zero.
@@ -274,39 +290,11 @@ Update a `Card`.
 
 ### PARAMS:
 
--  **`collection_preview`** nullable boolean.
-
--  **`visualization_settings`** nullable Value must be a map.
-
--  **`parameters`** nullable sequence of parameter must be a map with :id and :type keys.
-
--  **`description`** nullable string.
-
--  **`archived`** nullable boolean.
-
--  **`collection_position`** nullable value must be an integer greater than zero.
-
--  **`result_metadata`** nullable value must be an array of valid results column metadata maps.
-
--  **`enable_embedding`** nullable boolean.
-
--  **`collection_id`** nullable value must be an integer greater than zero.
-
--  **`card-updates`** 
-
--  **`name`** nullable value must be a non-blank string.
-
--  **`type`** nullable enum of :question, :metric, :model.
-
--  **`embedding_params`** nullable value must be a valid embedding params map.
-
--  **`cache_ttl`** nullable value must be an integer greater than zero.
-
--  **`dataset_query`** nullable Value must be a map.
-
 -  **`id`** value must be an integer greater than zero.
 
--  **`display`** nullable value must be a non-blank string.
+-  **`delete_old_dashcards`** nullable boolean.
+
+-  **`body`** map where {:name (optional) -> <nullable value must be a non-blank string.>, :parameters (optional) -> <nullable sequence of parameter must be a map with :id and :type keys>, :dataset_query (optional) -> <nullable Value must be a map.>, :type (optional) -> <nullable enum of :question, :metric, :model>, :display (optional) -> <nullable value must be a non-blank string.>, :description (optional) -> <nullable string>, :visualization_settings (optional) -> <nullable Value must be a map.>, :archived (optional) -> <nullable boolean>, :enable_embedding (optional) -> <nullable boolean>, :embedding_params (optional) -> <nullable value must be a valid embedding params map.>, :collection_id (optional) -> <nullable value must be an integer greater than zero.>, :collection_position (optional) -> <nullable value must be an integer greater than zero.>, :result_metadata (optional) -> <nullable value must be an array of valid results column metadata maps.>, :cache_ttl (optional) -> <nullable value must be an integer greater than zero.>, :collection_preview (optional) -> <nullable boolean>, :dashboard_id (optional) -> <nullable value must be an integer greater than zero.>}.
 
 ---
 

docs/api/cards.md

@@ -0,0 +1,42 @@
+---
+title: "Cards"
+summary: |
+  Bulk endpoints for Cards.
+---
+
+# Cards
+
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
+Bulk endpoints for Cards.
+
+## `POST /api/cards/dashboards`
+
+Get the dashboards that multiple cards appear in. The response is a sequence of maps, each of which has a `card_id`
+  and `dashboards`. `dashboard` may include an `:error` key, either `:unreadable-dashboard` or
+  `:unwritable-dashboard`. In the case of an `unreadable-dashboard` the dashboard details (name, ID) will NOT be
+  present.
+
+### PARAMS:
+
+-  **`card_ids`** sequence of value must be an integer greater than zero.
+
+## `POST /api/cards/move`
+
+Moves a number of Cards to a single collection or dashboard.
+
+  For now, just either succeed or fail as a batch - we can think more about error handling later down the road.
+
+### PARAMS:
+
+-  **`card_ids`** sequence of value must be an integer greater than zero.
+
+-  **`collection_id`** nullable value must be an integer greater than zero.
+
+-  **`dashboard_id`** nullable value must be an integer greater than zero.
+
+---
+
+[<< Back to API index](../api-documentation.md)

docs/api/channel.md

@@ -8,6 +8,10 @@ summary: |
 
 # Channel
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/channel endpoints.
 
   Currently only used for http channels.

docs/api/cloud-migration.md

@@ -9,6 +9,10 @@ summary: |
 
 # Cloud migration
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/cloud-migration endpoints.
   Only one migration should be happening at any given time.
   But if something weird happens with concurrency, /cancel will

docs/api/collection.md

@@ -9,6 +9,10 @@ summary: |
 
 # Collection
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 `/api/collection` endpoints. By default, these endpoints operate on Collections in the 'default' namespace, which is
   the namespace that has things like Dashboards and Cards. Other namespaces of Collections exist as well, such as the
   `:snippet` namespace, ('Snippet folders' in the UI). These namespaces are independent hierarchies. To use these
@@ -55,6 +59,9 @@ Fetch a specific Collection's items with the following options:
                    when `is_not_pinned`, return non pinned objects only.
                    when `all`, return everything. By default returns everything.
 
+  Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is
+  changed, that should too.
+
 ### PARAMS:
 
 -  **`id`** value must be an integer greater than zero.
@@ -71,6 +78,8 @@ Fetch a specific Collection's items with the following options:
 
 -  **`official_collections_first`** nullable value must be a valid boolean string ('true' or 'false').
 
+-  **`show_dashboard_questions`** nullable value must be a valid boolean string ('true' or 'false').
+
 ## `GET /api/collection/:id/timelines`
 
 Fetch a specific Collection's timelines.
@@ -117,6 +126,9 @@ Fetch objects that the current user should see at their root level. As mentioned
   By default, this will show the 'normal' Collections namespace; to view a different Collections namespace, such as
   `snippets`, you can pass the `?namespace=` parameter.
 
+  Note that this endpoint should return results in a similar shape to `/api/dashboard/:id/items`, so if this is
+  changed, that should too.
+
 ### PARAMS:
 
 -  **`models`** nullable vector of enum of dashboard, dataset, no_models, timeline, snippet, collection, pulse, metric, card.
@@ -133,6 +145,8 @@ Fetch objects that the current user should see at their root level. As mentioned
 
 -  **`official_collections_first`** nullable value must be a valid boolean string ('true' or 'false').
 
+-  **`show_dashboard_questions`** nullable value must be a valid boolean string ('true' or 'false').
+
 ## `GET /api/collection/root/timelines`
 
 Fetch the root Collection's timelines.

docs/api/dashboard.md

@@ -6,6 +6,10 @@ summary: |
 
 # Dashboard
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/dashboard endpoints.
 
 ## `DELETE /api/dashboard/:dashboard-id/public_link`
@@ -62,6 +66,14 @@ Get Dashboard with ID.
 
 -  **`dashboard-load-id`**
 
+## `GET /api/dashboard/:id/items`
+
+Get Dashboard with ID.
+
+### PARAMS:
+
+-  **`id`** value must be an integer greater than zero.
+
 ## `GET /api/dashboard/:id/params/:param-key/search/:query`
 
 Fetch possible values of the parameter whose ID is `:param-key` that contain `:query`. Optionally restrict

docs/api/database.md

@@ -6,6 +6,10 @@ summary: |
 
 # Database
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/database endpoints.
 
 ## `DELETE /api/database/:id`
@@ -113,6 +117,8 @@ Return a list of `Card` autocomplete suggestions for a given `query` in a given
 
 -  **`query`** value must be a non-blank string.
 
+-  **`include_dashboard_questions`** value must be a valid boolean string ('true' or 'false').
+
 ## `GET /api/database/:id/fields`
 
 Get a list of all `Fields` in `Database`.

docs/api/dataset.md

@@ -6,6 +6,10 @@ summary: |
 
 # Dataset
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/dataset endpoints.
 
 ## `POST /api/dataset/`

docs/api/ee/advanced-config-logs.md

@@ -11,6 +11,10 @@ summary: |
 
 # Advanced config logs
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/logs endpoints.
 
   These endpoints are meant to be used by admins to download logs before entries are auto-removed after the day limit.

docs/api/ee/advanced-permissions-application.md

@@ -8,6 +8,10 @@ summary: |
 
 # Advanced permissions application
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 `/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.

docs/api/ee/advanced-permissions-impersonation.md

@@ -6,6 +6,10 @@ summary: |
 
 # Advanced permissions impersonation
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Advanced permissions impersonation.
 
 ## `DELETE /api/ee/advanced-permissions/impersonation/:id`

docs/api/ee/audit-app-user.md

@@ -6,6 +6,10 @@ summary: |
 
 # Audit app user
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 `/api/ee/audit-app/user` endpoints. These only work if you have a premium token with the `:audit-app` feature.
 
 ## `DELETE /api/ee/audit-app/user/:id/subscriptions`

docs/api/ee/content-verification-review.md

@@ -6,6 +6,10 @@ summary: |
 
 # Content verification review
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Content verification review.
 
 ## `POST /api/moderation-review/review/`

docs/api/ee/query-reference-validation.md

@@ -6,6 +6,10 @@ summary: |
 
 # Query reference validation
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Query reference validation.
 
 ## `GET /api/ee/query-reference-validation/invalid-cards`

docs/api/ee/sandbox-gtap.md

@@ -6,6 +6,10 @@ summary: |
 
 # Sandbox GTAP
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 `/api/mt/gtap` endpoints, for CRUD operations and the like on GTAPs (Group Table Access Policies).
 
 ## `DELETE /api/mt/gtap/:id`

docs/api/ee/sandbox-table.md

@@ -6,6 +6,10 @@ summary: |
 
 # Sandbox table
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Sandbox table.
 
 ## `GET /api/table/:id/query_metadata`

docs/api/ee/sandbox-user.md

@@ -6,6 +6,10 @@ summary: |
 
 # Sandbox user
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 Endpoint(s)for setting user attributes.
 
 ## `GET /api/mt/user/attributes`

docs/api/ee/serialization.md

@@ -6,6 +6,10 @@ summary: |
 
 # Serialization
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Serialization.
 
 ## `POST /api/ee/serialization/export`

docs/api/ee/sso.md

@@ -9,6 +9,10 @@ summary: |
 
 # SSO
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 `/auth/sso` Routes.
 
   Implements the SSO routes needed for SAML and JWT. This namespace primarily provides hooks for those two backends so

docs/api/ee/upload-management.md

@@ -6,6 +6,10 @@ summary: |
 
 # Upload management
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Upload management.
 
 ## `DELETE /api/ee/upload-management/tables/:id`

docs/api/email.md

@@ -6,6 +6,10 @@ summary: |
 
 # Email
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/email endpoints.
 
 ## `DELETE /api/email/`

docs/api/embed.md

@@ -20,6 +20,10 @@ summary: |
 
 # Embed
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 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.
 

docs/api/field.md

@@ -6,6 +6,10 @@ summary: |
 
 # Field
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Field.
 
 ## `DELETE /api/field/:id/dimension`

docs/api/geojson.md

@@ -6,6 +6,10 @@ summary: |
 
 # GeoJSON
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for GeoJSON.
 
 ## `GET /api/geojson/`

docs/api/google.md

@@ -6,6 +6,10 @@ summary: |
 
 # Google
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/google endpoints.
 
 ## `PUT /api/google/settings`

docs/api/ldap.md

@@ -6,6 +6,10 @@ summary: |
 
 # LDAP
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/ldap endpoints.
 
 ## `PUT /api/ldap/settings`

docs/api/llm.md

@@ -6,6 +6,10 @@ summary: |
 
 # LLM
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for LLM.
 
 ## `POST metabase-enterprise.llm.api/card/summarize`

docs/api/login-history.md

@@ -6,6 +6,10 @@ summary: |
 
 # Login history
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Login history.
 
 ## `GET /api/login-history/current`

docs/api/metabot.md

@@ -6,6 +6,10 @@ summary: |
 
 # Metabot
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 These Metabot endpoints are for an experimental feature.
 
 ## `POST /api/metabot/database/:database-id`

docs/api/model-index.md

@@ -6,6 +6,10 @@ summary: |
 
 # Model index
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Model index.
 
 ## `DELETE /api/model-index/:id`

docs/api/native-query-snippet.md

@@ -6,6 +6,10 @@ summary: |
 
 # Native query snippet
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 Native query snippet (/api/native-query-snippet) endpoints.
 
 ## `GET /api/native-query-snippet/`

docs/api/notify.md

@@ -6,6 +6,10 @@ summary: |
 
 # Notify
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/notify/* endpoints which receive inbound etl server notifications.
 
 ## `POST /api/notify/db/:id`

docs/api/permissions.md

@@ -6,6 +6,10 @@ summary: |
 
 # Permissions
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/permissions endpoints.
 
 ## `DELETE /api/permissions/group/:group-id`

docs/api/persist.md

@@ -6,6 +6,10 @@ summary: |
 
 # Persist
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Persist.
 
 ## `GET /api/persist/`

docs/api/premium-features.md

@@ -6,6 +6,10 @@ summary: |
 
 # Premium features
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Premium features.
 
 ## `GET /api/premium-features/token/status`

docs/api/preview-embed.md

@@ -14,6 +14,10 @@ summary: |
 
 # Preview embed
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 Endpoints for previewing how Cards and Dashboards will look when embedding them.
    These endpoints are basically identical in functionality to the ones in `/api/embed`, but:
 

docs/api/public.md

@@ -6,6 +6,10 @@ summary: |
 
 # Public
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 Metabase API endpoints for viewing publicly-accessible Cards and Dashboards.
 
 ## `GET /api/public/action/:uuid`

docs/api/pulse.md

@@ -9,6 +9,10 @@ summary: |
 
 # Pulse
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 `/api/pulse` endpoints. These are all authenticated. For unauthenticated `/api/pulse/unsubscribe` endpoints,
   see [[metabase.api.pulse.unsubscribe]].
 

docs/api/revision.md

@@ -6,6 +6,10 @@ summary: |
 
 # Revision
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Revision.
 
 ## `GET /api/revision/`

docs/api/routes.md

@@ -6,6 +6,10 @@ summary: |
 
 # Routes
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Routes.
 
 ## `GET /api/routes/docs*`

docs/api/scim.md

@@ -6,6 +6,10 @@ summary: |
 
 # SCIM
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/ee/scim/ endpoints.
 
 ## `GET metabase-enterprise.scim.api/api_key`

docs/api/search.md

@@ -6,6 +6,10 @@ summary: |
 
 # Search
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Search.
 
 ## `GET /api/search/`
@@ -44,6 +48,8 @@ Search for items in Metabase.
 
 -  **`created_at`** nullable value must be a non-blank string.
 
+-  **`include_dashboard_questions`** nullable boolean.
+
 -  **`archived`** nullable boolean.
 
 -  **`q`** nullable value must be a non-blank string.

docs/api/segment.md

@@ -6,6 +6,10 @@ summary: |
 
 # Segment
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/segment endpoints.
 
 ## `DELETE /api/segment/:id`

docs/api/session.md

@@ -6,6 +6,10 @@ summary: |
 
 # Session
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/session endpoints.
 
 ## `DELETE /api/session/`

docs/api/setting.md

@@ -6,6 +6,10 @@ summary: |
 
 # Setting
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/setting endpoints.
 
 ## `GET /api/setting/`

docs/api/setup.md

@@ -6,6 +6,10 @@ summary: |
 
 # Setup
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for Setup.
 
 ## `GET /api/setup/admin_checklist`

docs/api/slack.md

@@ -6,6 +6,10 @@ summary: |
 
 # Slack
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/slack endpoints.
 
 ## `GET /api/slack/manifest`

docs/api/sso-saml.md

@@ -6,6 +6,10 @@ summary: |
 
 # SSO SAML
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 `/api/saml` endpoints.
 
 ## `PUT /auth/saml/settings`

docs/api/stale.md

@@ -7,6 +7,10 @@ summary: |
 
 # Stale
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 API endpoints for retrieving or archiving stale (unused) items.
   Currently supports Dashboards and Cards.
 

docs/api/table.md

@@ -6,6 +6,10 @@ summary: |
 
 # Table
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/table endpoints.
 
 ## `GET /api/table/`

docs/api/task.md

@@ -6,6 +6,10 @@ summary: |
 
 # Task
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/task endpoints.
 
 ## `GET /api/task/`

docs/api/tiles.md

@@ -6,6 +6,10 @@ summary: |
 
 # Tiles
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 `/api/tiles` endpoints.
 
 ## `GET /api/tiles/:zoom/:x/:y/:lat-field/:lon-field`

docs/api/timeline-event.md

@@ -6,6 +6,10 @@ summary: |
 
 # Timeline event
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/timeline-event endpoints.
 
 ## `DELETE /api/timeline-event/:id`

docs/api/timeline.md

@@ -6,6 +6,10 @@ summary: |
 
 # Timeline
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/timeline endpoints.
 
 ## `DELETE /api/timeline/:id`

docs/api/user-key-value.md

@@ -0,0 +1,59 @@
+---
+title: "User key value"
+summary: |
+  API endpoints for User key value.
+---
+
+# User key value
+
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
+API endpoints for User key value.
+
+## `DELETE /api/user-key-value/namespace/:namespace/key/:key`
+
+Deletes a KV-pair for the user.
+
+### PARAMS:
+
+-  **`namespace`** 
+
+-  **`key`**
+
+## `GET /api/user-key-value/namespace/:namespace`
+
+Returns all KV pairs in a given namespace for the current user.
+
+### PARAMS:
+
+-  **`namespace`** value must be a non-blank string.
+
+## `GET /api/user-key-value/namespace/:namespace/key/:key`
+
+Get a value for the user.
+
+### PARAMS:
+
+-  **`namespace`** value must be a non-blank string.
+
+-  **`key`** value must be a non-blank string.
+
+## `PUT /api/user-key-value/namespace/:namespace/key/:key`
+
+Upsert a KV-pair for the user.
+
+### PARAMS:
+
+-  **`v`** anything.
+
+-  **`expires_at`** nullable regex pattern matching #"^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}(?::\d{2}(?:\.\d{1,6})?)?$", or regex pattern matching #"^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}(?::\d{2}(?:\.\d{1,6})?)?(?:Z|(?:[+-]\d{2}:\d{2}(?::\d{2}(?:\.\d{1,6})?)?))$".
+
+-  **`namespace`** value must be a non-blank string.
+
+-  **`k`** value must be a non-blank string.
+
+---
+
+[<< Back to API index](../api-documentation.md)

docs/api/user.md

@@ -6,6 +6,10 @@ summary: |
 
 # User
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 /api/user endpoints.
 
 ## `DELETE /api/user/:id`

docs/api/util.md

@@ -7,6 +7,10 @@ summary: |
 
 # Util
 
+> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.
+
 Random utilty endpoints for things that don't belong anywhere else in particular, e.g. endpoints for certain admin
   page tasks.
 

src/metabase/cmd/endpoint_dox.clj

@@ -85,6 +85,12 @@
     (str "---\ntitle: \"" ep "\""
          "\nsummary: " desc "\n---\n\n")))
 
+(def ^:private endpoint-page-banner
+  "A header for the API docs page."
+  "> You can view live OpenAPI docs in your own running Metabase at `/api/docs`.
+   So if your Metabase is at https://www.your-metabase.com you could view
+   the API docs at https://www.your-metabase.com/api/docs.")
+
 (defn- endpoint-page-title
   "Creates a page title for a set of endpoints, e.g., `# Card`."
   [ep-title]
@@ -171,6 +177,7 @@
   (apply str
          (endpoint-page-frontmatter ep ep-data)
          (endpoint-page-title ep)
+         (str endpoint-page-banner "\n\n")
          (endpoint-page-description ep ep-data)
          (endpoint-docs ep-data)
          (endpoint-footer ep-data)))

src/metabase/cmd/resources/api-intro.md

@@ -19,6 +19,10 @@ clojure -M:ee:doc api-documentation
 
 Check out an introduction to the [Metabase API](https://www.metabase.com/learn/administration/metabase-api.html).
 
+## Live OpenAPI docs
+
+You can view live OpenAPI docs in your own running Metabase at `/api/docs`. So if your Metabase is at https://www.your-metabase.com you could view the API docs at https://www.your-metabase.com/api/docs.
+
 ## API keys
 
 Create keys to authenticate programmatic requests to your Metabase. See [API keys](./people-and-groups/api-keys.md).