From 785be0323dcee545c33b390384af7f01e8f9f440 Mon Sep 17 00:00:00 2001 From: or-else Date: Tue, 7 Apr 2020 09:06:21 +0300 Subject: [PATCH] update docs per #412 --- docs/API.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 3996fe15c..a59139e7a 100644 --- a/docs/API.md +++ b/docs/API.md @@ -628,6 +628,8 @@ The user agent `ua` is expected to follow [RFC 7231 section 5.5.3](http://tools. Message `{acc}` creates users or updates `tags` or authentication credentials `scheme` and `secret` of exiting users. To create a new user set `user` to the string `new` optionally followed by any character sequence, e.g. `newr15gsr`. Either authenticated or anonymous session can send an `{acc}` message to create a new user. To update authentication data or validate a credential of the current user leave `user` unset. +The `{acc}` message **cannot** be used to modify `desc` of an existing user. Update user's `me` topic instead. + ```js acc: { id: "1a2b3", // string, client-provided message id, optional @@ -656,7 +658,7 @@ acc: { ], desc: { // object, user initialisation data closely matching that of table - // initialisation; optional + // initialisation; used only when creating an account; optional defacs: { auth: "JRWS", // string, default access mode for peer to peer conversations // between this user and other authenticated users