Improve recommendation for how to form transaction IDs (#1888)

Fixes: #1706 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
matrix-org · Jun 25, 2024 · 7eda6ad · 7eda6ad
1 parent 7820771
commit 7eda6ad
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/changelogs/client_server/newsfragments/1888.clarification b/changelogs/client_server/newsfragments/1888.clarification
@@ -0,0 +1 @@
+Improve recommendation for how to form transaction IDs.
diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md
@@ -251,9 +251,10 @@ the request idempotent.
 
 The transaction ID should **only** be used for this purpose.
 
-From the client perspective, after the request has finished, the `{txnId}`
-value should be changed by for the next request (how is not specified; a
-monotonically increasing integer is recommended).
+After the request has finished, clients should change the `{txnId}` value for
+the next request. How this is achieved, is left as an implementation detail.
+It is recommended that clients use either version 4 UUIDs or a concatenation
+of the current timestamp and a monotonically increasing integer.
 
 The homeserver should identify a request as a retransmission if the
 transaction ID is the same as a previous request, and the path of the