docs - update API docs (#47471)

docs/api-documentation.md

@@ -40,6 +40,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)
+- [Channel](api/channel.md)
 - [Cloud migration](api/cloud-migration.md)
 - [Collection](api/collection.md)
 - [Content verification review*](api/ee/content-verification-review.md)

docs/api/activity.md

@@ -38,7 +38,7 @@ Adds a model to the list of recently selected items.
 
 ### PARAMS:
 
--  **`model`** enum of :card, :dataset, :dashboard, :table, :collection.
+-  **`model`** enum of :card, :dataset, :metric, :dashboard, :table, :collection.
 
 -  **`model_id`** value must be an integer greater than zero.
 

docs/api/card.md

@@ -130,7 +130,7 @@ Fetch a list of Cards with public UUIDs. These cards are publicly-accessible *if
 
 ## `POST /api/card/`
 
-Create a new `Card`.
+Create a new `Card`. Card `type` can be `question`, `metric`, or `model`.
 
 ### PARAMS:
 

docs/api/channel.md

+---
+title: "Channel"
+summary: |
+  /api/channel endpoints.
+  
+    Currently only used for http channels.
+---
+
+# Channel
+
+/api/channel endpoints.
+
+  Currently only used for http channels.
+
+## `GET /api/channel/`
+
+Get all channels.
+
+### PARAMS:
+
+-  **`include_inactive`** nullable boolean.
+
+## `GET /api/channel/:id`
+
+Get a channel.
+
+### PARAMS:
+
+-  **`id`** value must be an integer greater than zero.
+
+## `POST /api/channel/`
+
+Create a channel.
+
+### PARAMS:
+
+-  **`name`** value must be a non-blank string.
+
+-  **`description`** nullable value must be a non-blank string.
+
+-  **`type`** Must be a namespaced channel. E.g: channel/http.
+
+-  **`active`** nullable boolean.
+
+-  **`details`** map.
+
+## `POST /api/channel/test`
+
+Test a channel connection.
+
+### PARAMS:
+
+-  **`type`** Must be a namespaced channel. E.g: channel/http.
+
+-  **`details`** map.
+
+## `PUT /api/channel/:id`
+
+Update a channel.
+
+### PARAMS:
+
+-  **`id`** value must be an integer greater than zero.
+
+-  **`name`** nullable value must be a non-blank string.
+
+-  **`type`** nullable Must be a namespaced channel. E.g: channel/http.
+
+-  **`description`** nullable value must be a non-blank string.
+
+-  **`details`** nullable map.
+
+-  **`active`** nullable boolean.
+
+---
+
+[<< Back to API index](../api-documentation.md)
\ No newline at end of file

docs/api/database.md

@@ -35,6 +35,11 @@ Fetch all `Databases`.
 
   * `include_only_uploadable` will only include DBs into which Metabase can insert new data.
 
+  Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in
+  [[metabase.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for `:model/Database`
+  in [[metabase.models.database]] to exclude the `details` field, if the requesting user lacks permission to change the
+  database details.
+
 ### PARAMS:
 
 -  **`include`** include must be either empty or the value tables.
@@ -61,6 +66,11 @@ Get a single Database with `id`. Optionally pass `?include=tables` or `?include=
    In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID
    and tables, with no additional metadata.
 
+   Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in
+   [[metabase.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for `:model/Database`
+   in [[metabase.models.database]] to exclude the `details` field, if the requesting user lacks permission to change the
+   database details.
+
 ### PARAMS:
 
 -  **`id`** value must be an integer greater than zero.

docs/api/util.md

@@ -32,6 +32,14 @@ Return a cryptographically secure random 32-byte token, encoded as a hexadecimal
 Anonymous usage stats. Endpoint for testing, and eventually exposing this to instance admins to let them see
   what is being phoned home.
 
+## `POST /api/util/entity_id`
+
+Translate entity IDs to model IDs.
+
+### PARAMS:
+
+-  **`entity_ids`** map.
+
 ## `POST /api/util/password_check`
 
 Endpoint that checks if the supplied password meets the currently configured password complexity rules.

src/metabase/api/card.clj

@@ -464,7 +464,7 @@
                        :status-code 400})))))
 
 (api/defendpoint POST "/"
-  "Create a new `Card`."
+  "Create a new `Card`. Card `type` can be `question`, `metric`, or `model`."
   [:as {{:keys [collection_id collection_position dataset_query description display name
                 parameters parameter_mappings result_metadata visualization_settings cache_ttl type], :as body} :body}]
   {name                   ms/NonBlankString