Skip to content

Commit 3d67012

Browse files
committed
docs(types): the record-page timeline total's docblock reads it as an upper bound of the drawn entries
The RecordPageResponse.timeline docblock in @object-ui/types says what the spec's RecordPageTimelineCountSchema now says: the total counts the sources' rows, so it is an upper bound of the entries the panel draws, and names the two cases where the panel draws fewer. Comment only. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QsR2jUNaEANxba2LHLfyuZ
1 parent 21c2817 commit 3d67012

2 files changed

Lines changed: 9 additions & 3 deletions

File tree

‎.changeset/29138-timeline-total-describe.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
'@objectstack/spec': patch
3+
'@object-ui/types': patch
34
---
45

56
docs(spec): the record-page `timeline` total's published description reads it as an upper bound of the drawn 动态 entries
@@ -8,3 +9,5 @@ Clause-②: no
89
Metadata-protocol: none
910

1011
`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.
12+
13+
The `RecordPageResponse.timeline` docblock in `@object-ui/types`, the UI's mirror of the response, says the same: the total counts the sources' rows, so it is an upper bound of the drawn entries, and the panel draws fewer in the same two cases. Comment only: no type, member or export changes.

‎ui/packages/types/src/data.ts‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -423,9 +423,12 @@ export interface RecordPagePayload {
423423
/** The record's newest attachments and their count, or their read's refusal (objectstack#28470). */
424424
attachments?: { total: number; records: Record<string, any>[] } | { error: RecordPagePartRefusal };
425425
/**
426-
* How many entries the record's 动态 stream holds over the sources the
427-
* request named (objectstack#28737), or the refusal of a comment or
428-
* activity read.
426+
* The size of the record's 动态 stream over the sources the request named
427+
* (objectstack#28737), or the refusal of a comment or activity read. The
428+
* total counts the sources' rows, so it is an upper bound of the entries the
429+
* 动态 panel draws, not their number: the panel draws fewer where its
430+
* `showCompleted` / `types` configuration filters entries out, and where a
431+
* ledger row has no displayable diff and so draws no entry.
429432
*/
430433
timeline?: { total: number } | { error: RecordPagePartRefusal };
431434
}

0 commit comments

Comments
 (0)