Skip to content

Commit 0f76456

Browse files
committed
docs(spec): the record-page timeline total's description reads it as an upper bound of the drawn entries
RecordPageTimelineCountSchema's docblock and its total .describe() now say what the RecordPageTimelineRequestSchema docblock says: the total counts the sources' rows as that schema's table defines them, so it is an upper bound of the entries the panel draws. Regenerated the API reference page. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QsR2jUNaEANxba2LHLfyuZ
1 parent 276ca30 commit 0f76456

3 files changed

Lines changed: 22 additions & 4 deletions

File tree

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
'@objectstack/spec': patch
3+
---
4+
5+
docs(spec): the record-page `timeline` total's published description reads it as an upper bound of the drawn 动态 entries
6+
7+
Clause-②: no
8+
Metadata-protocol: none
9+
10+
`RecordPageTimelineCountSchema.total`'s `.describe()`, which ships in the published JSON schema and the API reference, and the schema's docblock now say what the `RecordPageTimelineRequestSchema` docblock says: the total counts the rows of the sources the request named, as that schema's table defines them and as the caller may read them. That makes it an upper bound of the entries the 动态 panel draws, not their number. The panel draws fewer where its `showCompleted` / `types` configuration filters entries out, and where a ledger row has no displayable diff. Description text only: no key, type, bound, default or export changes, and no behaviour changes.

‎content/docs/references/api/record-page.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -548,7 +548,7 @@ This schema accepts one of the following structures:
548548

549549
| Property | Type | Required | Description |
550550
| :--- | :--- | :--- | :--- |
551-
| **total** | `integer` | ✅ | How many entries the record's timeline stream holds for this caller, over the sources the request named. |
551+
| **total** | `integer` | ✅ | The rows of the sources the request named, counted as this caller may read them: an upper bound of the entries the timeline panel draws, not their number. The panel draws fewer where its `showCompleted` / `types` configuration filters entries out, and where a ledger row has no displayable diff. |
552552

553553
### Nested Shape: `RecordPageResponse.timeline[option 2]`
554554

@@ -596,7 +596,7 @@ This schema accepts one of the following structures:
596596

597597
| Property | Type | Required | Description |
598598
| :--- | :--- | :--- | :--- |
599-
| **total** | `integer` | ✅ | How many entries the record's timeline stream holds for this caller, over the sources the request named. |
599+
| **total** | `integer` | ✅ | The rows of the sources the request named, counted as this caller may read them: an upper bound of the entries the timeline panel draws, not their number. The panel draws fewer where its `showCompleted` / `types` configuration filters entries out, and where a ledger row has no displayable diff. |
600600

601601

602602
---

‎packages/spec/src/api/record-page.zod.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -313,10 +313,18 @@ export const RecordPageStreamRowsSchema = lazySchema(() => z.object({
313313
export type RecordPageStreamRows = z.input<typeof RecordPageStreamRowsSchema>;
314314
export type RecordPageStreamRowsParsed = z.infer<typeof RecordPageStreamRowsSchema>;
315315

316-
/** [#28737] The `timeline` part: how many entries the record's 动态 stream holds. */
316+
/**
317+
* [#28737] The `timeline` part: the size of the record's 动态 stream, counted
318+
* by the reads `RecordPageTimelineRequestSchema` names, as the caller. The
319+
* total counts the sources' rows as that schema's table defines them, so it is
320+
* an upper bound of the entries the 动态 panel draws, not their number. The
321+
* panel draws fewer where its `showCompleted` / `types` configuration filters
322+
* entries out, and where a ledger row has no displayable diff and so draws no
323+
* entry.
324+
*/
317325
export const RecordPageTimelineCountSchema = lazySchema(() => z.object({
318326
total: z.number().int().min(0).describe(
319-
'How many entries the record\'s timeline stream holds for this caller, over the sources the request named.',
327+
'The rows of the sources the request named, counted as this caller may read them: an upper bound of the entries the timeline panel draws, not their number. The panel draws fewer where its `showCompleted` / `types` configuration filters entries out, and where a ledger row has no displayable diff.',
320328
),
321329
}).strict());
322330
export type RecordPageTimelineCount = z.input<typeof RecordPageTimelineCountSchema>;

0 commit comments

Comments
 (0)