README: document the member self-serve guest flow and the trial gate

This commit is contained in:
inference-bot committed 2026-11-08 02:53:00 +00:00
1 parent 6220812e08
commit 7a63b3a728
1 file changed
+17
+17
View File
@@ -72,6 +72,23 @@ guest per recipient ever; the inviter must be an active member; an existing
portal row under the recipient address is refused. Guests are subscribed to portal row under the recipient address is refused. Guests are subscribed to
the newsletter and invited to NOTHING else (no Loomio, no Matrix). the newsletter and invited to NOTHING else (no Loomio, no Matrix).
**Member self-serve invitations (trial gate).** `POST /broker/guests` (the
member-dashboard broker identity — a guest identity fails it) lets a MEMBER
invite a guest from their dashboard: `{"email", "name"}`. The same guards run
BEFORE anything is created (`guest_request_guard`: everything above, plus the
recipient is never a `MANUAL_MEMBERS` address or an already-pending request,
and the inviter's rolling window counts pending + approved REQUESTS too).
With `GUEST_AUTO_APPROVE` **off** (the default) the request lands PENDING in
the `guest_requests` table and the operator approves or rejects it from the
panel — `GET /admin/guest-requests` (queue + ledger, pending vs approved in
one view), `POST /admin/guest-requests/{id}/approve` (fires the full guest
pipeline above; every guard re-runs and a moved-state refusal is recorded on
the request) or `.../reject`. The recipient is contacted only on approval;
the inviting member sees pending/not-approved in their own trail via
`GET /broker/guests`. With `GUEST_AUTO_APPROVE=1` a member's request
provisions immediately — flipping the gate is an env change, not a code
change.
**Sweep safety.** `reconcile_memberships()` never deactivates a guest for **Sweep safety.** `reconcile_memberships()` never deactivates a guest for
lacking an OC contribution. A guest lapses only by its own rules, handled by lacking an OC contribution. A guest lapses only by its own rules, handled by
`reconcile_guest_lifecycles()` inside the sweep: credits spent out (LiteLLM's `reconcile_guest_lifecycles()` inside the sweep: credits spent out (LiteLLM's