Skip to content

Commit 9810aeb

Browse files
committed
chore(changeset): spec minor for the declared dataset-answer object
Clause-② is yes (widening): AnalyticsResult and its response schema gain one optional member. Claude-Session: https://claude.ai/code/session_01Sfe5YjBLwB9J3y8fvm2xq1 Co-authored-by: Claude <noreply@anthropic.com>
1 parent 159d84d commit 9810aeb

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
'@objectstack/spec': minor
3+
---
4+
5+
feat(spec): a dataset answer declares its base object as `object` (#20647)
6+
7+
Clause-②: yes (widening)
8+
9+
`AnalyticsResult` (`@objectstack/spec/contracts`) gains one optional member,
10+
`object?: string`, and `AnalyticsResultResponseSchema` (`@objectstack/spec/api`)
11+
mirrors it on `data`. It is the base object of the dataset the answer was
12+
computed from, by machine name. Nothing is removed or renamed, and no existing
13+
member changes meaning.
14+
15+
**For a consumer.** Code typed against `AnalyticsResult` can read `object` from a
16+
`queryDataset` answer without a cast, and a parse with
17+
`AnalyticsResultResponseSchema` keeps `data.object` where it used to strip it. The
18+
contract asks every dataset answer to carry it, whatever dimensions are selected
19+
and whether or not rows came back. A cube query answer has no dataset behind it
20+
and carries none.
21+
22+
**Producers.** This release declares the member. `@objectstack/service-analytics`
23+
sets it on every dataset answer once #20644 lands.

0 commit comments

Comments
 (0)