From 16d319400ae86e7b9df1b2634efcb8c781ac813a Mon Sep 17 00:00:00 2001
From: Gustavo Saiani <gustavo@poe.ma>
Date: Fri, 4 Mar 2022 11:59:18 -0300
Subject: [PATCH] Document entity api response requirements (#20802)

---
 frontend/src/metabase/lib/entities.js | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/frontend/src/metabase/lib/entities.js b/frontend/src/metabase/lib/entities.js
index 3396c109940..d35b59d32df 100644
--- a/frontend/src/metabase/lib/entities.js
+++ b/frontend/src/metabase/lib/entities.js
@@ -1,6 +1,12 @@
 /*
  * # Entities abstract the interface between the back-end and the front-end.
  *
+ * ## Endpoint requirements for entities:
+ *
+ * When fetching a list, each item of the list must include an `id` key/value pair.
+ *
+ * JSON must wrap response inside a `{ "data" : { …your data } }` structure.
+ *
  * ## Required Properties:
  *
  * name:
-- 
GitLab