docs: setup API docs and document mode param

nikgraf · Oct 14, 2023 · 4a21c46 · 4a21c46
1 parent a72be53
commit 4a21c46
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/documentation/pages/docs/_meta.json b/documentation/pages/docs/_meta.json
@@ -1,6 +1,7 @@
 {
   "getting-started": "Getting started",
   "examples": "Examples",
+  "api": "API",
   "error-handling": "Error Handling",
   "security_and_privacy": "Security & Privacy",
   "specification": "Specification",

diff --git a/documentation/pages/docs/api.mdx b/documentation/pages/docs/api.mdx
@@ -0,0 +1,12 @@
+# API
+
+## Mode
+
+Can be `"complete"` or `"delta"`. The default is `"complete"`
+
+Providing `"complete"` informs the backend that the entire document should be loaded. This means the last known snapshot and all connected updates.
+
+Setting it to `"delta"` means the only the necessary updates should be provided. This means only the necessary data is retrieved e.g.
+
+1. Client is aware of the latest snapshot and three updates and only misses two updates then only two updates are sent.
+2. Client is aware of an older snapshot, then the latest snapshot and all it's updates are sent.