Merge pull request #844 from Sanofi-IADC/feature/WEB-2336-docs

chore: WEB-2336 data index key documentation update
Sanofi-IADC · Jul 10, 2024 · 6c0d4e3 · 6c0d4e3
2 parents 0204d35 + 69f4fb6
commit 6c0d4e3
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/models/whisp.md b/docs/models/whisp.md
@@ -115,3 +115,9 @@ Description: The date after which the whisp will be deleted automatically. defin
 Type: JSONObject
 
 Description: An object containing the details of the whisp specific to the application
+
+## dataIndexKey
+
+Type: String
+
+Description: A string which represent your data. You can store strings which are most used inside and represents your data. You can use this key in filter to query whisps instead of running complex queries on top of data object. This is an indexed field.