Commit 5f397fd
committed
docs(client): the SDK examples read the resolved payload
`analytics.query` / `analytics.meta` / `analytics.explain` and
`automation.trigger` resolve to the payload rather than the dispatcher's
`{ success, data }` envelope, but the three places a reader first meets the
SDK showed the calls with nothing reading the resolved value: the page was
neither wrong nor instructive about the shape.
One payload read per example, on all three sites together — the docs site's
Client SDK page, the Data API page's `GET /analytics/meta` prose, and the
`@objectstack/client` README — using the members the contracts declare
(`AnalyticsResult.rows` / `.fields[].name`, the bare `CubeMeta[]`,
`{ sql, params }`, `AutomationResult.status`).
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AhooRxUmvwYwcnQ5LATTB71 parent 1f2a02b commit 5f397fd
4 files changed
Lines changed: 25 additions & 6 deletions
File tree
- .changeset
- content/docs/api
- packages/client
Lines changed: 9 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
316 | 316 | | |
317 | 317 | | |
318 | 318 | | |
| 319 | + | |
319 | 320 | | |
320 | 321 | | |
321 | 322 | | |
| 323 | + | |
322 | 324 | | |
323 | 325 | | |
324 | 326 | | |
325 | 327 | | |
326 | 328 | | |
327 | 329 | | |
| 330 | + | |
328 | 331 | | |
329 | 332 | | |
330 | 333 | | |
| |||
430 | 433 | | |
431 | 434 | | |
432 | 435 | | |
433 | | - | |
| 436 | + | |
| 437 | + | |
434 | 438 | | |
435 | 439 | | |
436 | 440 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
444 | 444 | | |
445 | 445 | | |
446 | 446 | | |
447 | | - | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
448 | 451 | | |
449 | 452 | | |
450 | 453 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
269 | 269 | | |
270 | 270 | | |
271 | 271 | | |
272 | | - | |
273 | | - | |
274 | | - | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
275 | 277 | | |
276 | 278 | | |
277 | | - | |
| 279 | + | |
| 280 | + | |
278 | 281 | | |
279 | 282 | | |
280 | 283 | | |
| |||
0 commit comments