From 1f875de593751a60ab148e462acdeffd524d4ad5 Mon Sep 17 00:00:00 2001 From: Palestrina Date: Sat, 6 Jun 2026 09:55:16 +0000 Subject: [PATCH] docs: explicitly state that _sharing is not inherited and defaults to private MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The existing docs describe _sharing defaults and _inheritrights propagation in separate sections, but neither explicitly states the combined behaviour: _sharing is not propagated via _inheritrights, and an entity with no explicit _sharing defaults to private regardless of its parent. This has caused two independent integrator teams to assume _sharing inherits like the four rights properties do. One-line info block in the Sharing section, between the existing danger block and the Rights Inheritance heading. Closes #12 Co-authored-by: Mihkel Putrinš --- src/overview/entities/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/overview/entities/index.md b/src/overview/entities/index.md index 9d33aa4..48b9f65 100644 --- a/src/overview/entities/index.md +++ b/src/overview/entities/index.md @@ -64,6 +64,10 @@ Editing always requires `_editor` or `_owner` rights regardless of sharing level Setting `_sharing: public` makes the entity visible to anyone on the internet without authentication. Only use it for intentionally public content. ::: +::: info +`_sharing` is per-entity only — it is **not** propagated to children via `_inheritrights`. An entity with no explicit `_sharing` value defaults to `private`, regardless of its parent's `_sharing` setting. +::: + ### Rights Inheritance Set `_inheritrights: true` on an entity to inherit rights from its parent. Rights defined directly on the child override inherited ones. Use `_noaccess` to block a user who would otherwise inherit access from a parent.