Skip to content

Commit 13cd412

Browse files
authored
Fix docs for displaying snapshots via Rest (#4313)
1 parent d086dbe commit 13cd412

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

docs/book/how-to/snapshots/snapshots.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Without snapshots, each scenario would require:
4747

4848
- **Through REST API**: Your CI/CD system can trigger snapshots via API calls
4949
```bash
50-
curl -X POST 'https://your-zenml-server/api/v1/pipeline-snapshots/<ID>/runs' -H 'Authorization: Bearer <TOKEN>' -d '{"steps": {...}}'
50+
curl -X POST 'https://your-zenml-server/api/v1/pipeline-snapshots/<ID>/runs' -H 'Authorization: Bearer <TOKEN>' -d '{"run_configuration": {...}}'
5151
```
5252
- **Through Browser** (Pro feature): Non-technical stakeholders can run snapshots directly from the ZenML dashboard by simply filling in a form with the required parameters - no coding required!
5353

@@ -182,7 +182,7 @@ curl -X 'POST' \
182182
-H 'Content-Type: application/json' \
183183
-H 'Authorization: Bearer <YOUR-TOKEN>' \
184184
-d '{
185-
"steps": {"model_trainer": {"parameters": {"model_type": "rf"}}}
185+
"run_configuration" { "steps": {"model_trainer": {"parameters": {"model_type": "rf"}}}}
186186
}'
187187
```
188188

docs/book/user-guide/tutorial/trigger-pipelines-from-external-systems.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -266,15 +266,17 @@ curl -X 'POST' \
266266
-H 'Content-Type: application/json' \
267267
-H 'Authorization: Bearer <YOUR_TOKEN>' \
268268
-d '{
269-
"steps": {
270-
"load_data": {
271-
"parameters": {
272-
"data_url": "s3://production-bucket/latest-data.csv"
273-
}
274-
},
275-
"train_model": {
276-
"parameters": {
277-
"model_type": "gradient_boosting"
269+
"run_configuration": {
270+
"steps": {
271+
"load_data": {
272+
"parameters": {
273+
"data_url": "s3://production-bucket/latest-data.csv"
274+
}
275+
},
276+
"train_model": {
277+
"parameters": {
278+
"model_type": "gradient_boosting"
279+
}
278280
}
279281
}
280282
}

0 commit comments

Comments
 (0)