Skip to content

Commit 752d0f8

Browse files
committed
docs(api/rest): simplify pre-aggregation API examples
1 parent d9db9cb commit 752d0f8

File tree

1 file changed

+18
-35
lines changed

1 file changed

+18
-35
lines changed

docs/content/API-Reference/REST-API.mdx

Lines changed: 18 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -364,20 +364,12 @@ job.
364364

365365
Example request:
366366

367-
```json
368-
{
369-
"action": "post",
370-
"selector": {
371-
"contexts": [
372-
{ "securityContext": { "tenant": "tenant_1" } },
373-
{ "securityContext": { "tenant": "tenant_2" } }
374-
],
375-
"timezones": ["UTC", "America/Los_Angeles"],
376-
"datasources": ["default"],
377-
"cubes": ["Orders"],
378-
"preAggregations": ["Orders.ordersByStatus"]
379-
}
380-
}
367+
```bash
368+
curl \
369+
-d '{"action": "post", "selector": { "preAggregations": ["Orders.ordersByStatus"]}}' \
370+
-H "Authorization: EXAMPLE-API-TOKEN" \
371+
-X POST \
372+
https://localhost:4000/cubejs-system/v1/pre-aggregations/jobs
381373
```
382374

383375
Example response:
@@ -404,16 +396,12 @@ a `tokens` property.
404396

405397
Example request:
406398

407-
```json
408-
{
409-
"action": "get",
410-
"tokens": [
411-
"e9a6a0c55885cea5371348500ce7d7dc",
412-
"d1329b6c8d152e734fc4dcf7307b1b58",
413-
"6f4ea38373663fffc4334a576574845b",
414-
"ea903b10634b2f3141b35a2529870e89"
415-
]
416-
}
399+
```bash
400+
curl \
401+
-d '{"action": "get", "tokens": ["e9a6a0c55885cea5371348500ce7d7dc","d1329b6c8d152e734fc4dcf7307b1b58","6f4ea38373663fffc4334a576574845b","ea903b10634b2f3141b35a2529870e89"]}' \
402+
-H "Authorization: EXAMPLE-API-TOKEN" \
403+
-X POST \
404+
https://localhost:4000/cubejs-system/v1/pre-aggregations/jobs
417405
```
418406

419407
Example response:
@@ -497,17 +485,12 @@ Example response:
497485

498486
Example request with `resType: object`:
499487

500-
```json
501-
{
502-
"action": "get",
503-
"resType": "object",
504-
"tokens": [
505-
"e9a6a0c55885cea5371348500ce7d7dc",
506-
"d1329b6c8d152e734fc4dcf7307b1b58",
507-
"6f4ea38373663fffc4334a576574845b",
508-
"ea903b10634b2f3141b35a2529870e89"
509-
]
510-
}
488+
```bash
489+
curl \
490+
-d '{"action": "get", "resType": "object", "tokens": ["e9a6a0c55885cea5371348500ce7d7dc","d1329b6c8d152e734fc4dcf7307b1b58","6f4ea38373663fffc4334a576574845b","ea903b10634b2f3141b35a2529870e89"]}' \
491+
-H "Authorization: EXAMPLE-API-TOKEN" \
492+
-X POST \
493+
https://localhost:4000/cubejs-system/v1/pre-aggregations/jobs
511494
```
512495

513496
Example response with `resType: object`:

0 commit comments

Comments
 (0)