From 78217bc10f6dcffc90a11f955f20fea87ef54680 Mon Sep 17 00:00:00 2001 From: atlas Date: Wed, 19 Aug 2026 21:08:42 +0200 Subject: [PATCH] docs(swarm-authelia-bridge-sock): the bridge reads and writes users.yml, there is no canonical json MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The wire crate's module doc and its README both said the bridge "owns both users.json (canonical) and rendering users.yml internally". That store was removed — swarm-authelia-bridge/src/store.rs is explicit that users.yml *is* the store — so both sentences described a file that does not exist, in the one place a reader goes to learn what the API is for. The paragraph's actual argument (per-operation rather than wholesale-replace) is untouched; only the mechanism it cites was wrong. --- swarm-authelia-bridge-sock/README.md | 2 +- swarm-authelia-bridge-sock/src/lib.rs | 9 ++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/swarm-authelia-bridge-sock/README.md b/swarm-authelia-bridge-sock/README.md index d15c417b..69aa3035 100644 --- a/swarm-authelia-bridge-sock/README.md +++ b/swarm-authelia-bridge-sock/README.md @@ -18,6 +18,6 @@ client logic here, only the request/response shapes both sides import. One operation today: idempotently ensure an agent exists as an authelia subject. Deliberately **not** a wholesale-replace-the-file API — the bridge -owns both `users.json` (canonical) and rendering `users.yml` internally; a +reads `users.yml`, changes what the request named, and writes it back; a caller only ever asks for one user to exist, never sends rendered YAML or a file blob. See `swarm-authelia-bridge/README.md` for the helper itself. diff --git a/swarm-authelia-bridge-sock/src/lib.rs b/swarm-authelia-bridge-sock/src/lib.rs index c0fb0b60..963c5765 100644 --- a/swarm-authelia-bridge-sock/src/lib.rs +++ b/swarm-authelia-bridge-sock/src/lib.rs @@ -20,11 +20,10 @@ //! the file it writes. Fully ordinary permissions, no capabilities, no root. //! //! **Per-operation, not wholesale-replace.** [`BridgeRequest::EnsureAgentIdentity`] -//! asks for one user to exist; the bridge owns both `users.json` (canonical) -//! and rendering `users.yml` internally. A caller never sends rendered YAML -//! or a file blob — that would invite a last-writer-wins race between -//! independent callers and duplicate the rendering logic on both sides of -//! the wire. +//! asks for one user to exist; the bridge reads `users.yml`, changes what the +//! request named, and writes it back. A caller never sends rendered YAML or a +//! file blob — that would invite a last-writer-wins race between independent +//! callers and duplicate the rendering logic on both sides of the wire. use serde::{Deserialize, Serialize};