Skip to content

docs: fix BU subtree attribution in two docstrings (#8098)#8168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 2 commits into from
Aug 12, 2026
+26 −2
Merged

docs: fix BU subtree attribution in two docstrings (#8098) #8168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
801f0f4
docs: fix BU subtree attribution in two docstrings (#8098)
claude Aug 12, 2026
5a21315
chore: add changeset for BU subtree docstring fix (#8098)
claude Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .changeset/bu-subtree-docstring-attribution.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
---
"@objectstack/spec": patch
"@objectstack/platform-objects": patch
---

docs: fix `business_unit` sharing-rule docstrings that still attributed the BU subtree expansion to the narrow recipient (#8098)

#7807 (PR #8097, `9b519815`) narrowed the `business_unit` sharing-rule
recipient to expand exactly one unit's members, moving the subtree walk onto
`unit_and_subordinates`. Two docstrings never got the memo:
`IBusinessUnitGraphService` in `packages/spec/src/contracts/sharing-service.ts`
and the `sys_business_unit` object definition in
`packages/platform-objects/src/identity/sys-business-unit.object.ts`. Both
still said `recipient_type='business_unit'` sharing rules were driven by the
subtree walk. Both now name `unit_and_subordinates` as the subtree consumer,
with `business_unit` as the narrow (single-unit) one.

These are comment-only corrections — the `IBusinessUnitGraphService`
docstring surfaces in `@objectstack/spec`'s built `dist/**/*.d.ts` hover, and
the `sys_business_unit` docstring surfaces in
`@objectstack/platform-objects`'s built `dist/**/*.d.ts` hover; no runtime or
authoring behaviour changes.
3 changes: 2 additions & 1 deletion packages/platform-objects/src/identity/sys-business-unit.object.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,8 @@ import { ObjectSchema, Field } from '@objectstack/spec/data';
* structure works identically regardless of value.
*
* Drives:
* - `recipient_type='business_unit'` sharing rules
* - `recipient_type='unit_and_subordinates'` sharing rules (subtree walk);
* `business_unit` expands only the one named unit's members
* - `bu:` approver prefix in the approval engine
* - Report rollups and manager chains in CRM/PM apps
*
Expand Down
3 changes: 2 additions & 1 deletion packages/spec/src/contracts/sharing-service.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -562,7 +562,8 @@ export interface ITeamGraphService {
*
* Walks `parent_business_unit_id` to expand a department into the union of
* its members and all descendant members. Drives:
* - `recipient_type='business_unit'` sharing rules
* - `recipient_type='unit_and_subordinates'` sharing rules (this subtree
* walk); `business_unit` expands only the one named unit's members
* - `bu:` approver prefix in the approval engine
* - report rollups, manager chains, and similar org-aware logic
*/
Expand Down
Loading