diff options
Diffstat (limited to 'docs/USERGUIDE.md')
| -rw-r--r-- | docs/USERGUIDE.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md index 214b6e9..8a1e405 100644 --- a/docs/USERGUIDE.md +++ b/docs/USERGUIDE.md @@ -221,6 +221,25 @@ Response: Save `group_id` — you will need it in your `node.toml` and when adding members. +### The description + +Set it at creation with `"description"`, or later from the group's page — the owner +sees an **Edit description** link under the name. Members see it on their home page +and, for public groups, in Explore. + +``` +PATCH /v1/groups/{group_id} +Authorization: Bearer <access_token> (the group's owner) +{"description": "host grenoble"} +→ 200 {"group_id": "...", "description": "host grenoble"} +``` + +An empty string clears it; anything past 512 characters is trimmed rather than +refused. The description is all this endpoint changes: the name, the visibility and +the join policy are the terms members joined on, and a private group that could +quietly become public is not the group they agreed to be in. Changing those needs a +decision about who gets told, so it is not a field on a form. + ### Public vs. private groups | | Public | Private | @@ -815,6 +834,7 @@ they speak MNP (§6), and their only HTTP surface is the operator's admin UI on | POST | `/v1/groups` | Access token | Create group. Body: `name`. Returns `group_id`. | | GET | `/v1/groups` | None / Access token | List/search groups. Private groups require membership. | | GET | `/v1/groups/{group_id}` | None / Access token | Group metadata. | +| PATCH | `/v1/groups/{group_id}` | Access token (owner) | Edit the description. Body: `description`. Nothing else is editable — see §3. | | DELETE | `/v1/groups/{group_id}` | Access token (admin) | Revoke and delete group. | **GEK distribution — removed.** The hub used to carry wrapped group keys between members. |