You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: enhance README with detailed blueprint query parameters
- Updated the blueprint endpoint documentation to include a new optional query parameter `detailed`, allowing users to request comprehensive model parameter details.
- Clarified the response behavior based on the `detailed` parameter, specifying the difference between basic and full parameter information.
- Added example curl commands demonstrating the use of the `detailed` parameter for retrieving detailed blueprint information.
Copy file name to clipboardExpand all lines: README.md
+24-1Lines changed: 24 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -294,11 +294,16 @@ GET /problemStatements/{problemStatementId}/tasks/{taskId}/subtasks/{subtaskId}
294
294
**Get Blueprint for a Subtask**
295
295
296
296
```http
297
-
GET /problemStatements/{problemStatementId}/tasks/{taskId}/subtasks/{subtaskId}/blueprint
297
+
GET /problemStatements/{problemStatementId}/tasks/{taskId}/subtasks/{subtaskId}/blueprint?detailed={boolean}
298
298
```
299
299
300
300
This endpoint returns the complete model configuration blueprint for all models in a subtask, showing available parameters and data inputs.
301
301
302
+
**Query Parameters:**
303
+
-`detailed` (optional, boolean, default: false): Controls the level of parameter detail returned
304
+
-`false` or omitted: Returns basic parameter info (id, value) only
305
+
-`true`: Returns full ModelParameter details including type, description, min, max, etc.
306
+
302
307
## Programmatic Workflow Guide
303
308
304
309
This section describes how to programmatically use the Ensemble Manager to select models, configure parameters, and bind data for scientific modeling workflows.
@@ -447,10 +452,18 @@ curl -X GET "https://ensemble-manager.mint.tacc.utexas.edu/v1/problemStatements/
447
452
-H "Authorization: Bearer $JWT_TOKEN"
448
453
```
449
454
455
+
**For detailed parameter information (including type, description, min/max values):**
456
+
457
+
```bash
458
+
curl -X GET "https://ensemble-manager.mint.tacc.utexas.edu/v1/problemStatements/{problemStatementId}/tasks/{taskId}/subtasks/{subtaskId}/blueprint?detailed=true" \
459
+
-H "Authorization: Bearer $JWT_TOKEN"
460
+
```
461
+
450
462
**Copy-paste ready:**
451
463
452
464
```
453
465
// 5. Get Blueprint - No request body needed (GET request)
466
+
// Add ?detailed=true for full parameter details
454
467
```
455
468
456
469
**Example Blueprint Response:**
@@ -685,10 +698,18 @@ curl -X GET "https://ensemble-manager.mint.tacc.utexas.edu/v1/problemStatements/
685
698
-H "Authorization: Bearer $JWT_TOKEN"
686
699
```
687
700
701
+
**For detailed verification with full parameter information:**
702
+
703
+
```bash
704
+
curl -X GET "https://ensemble-manager.mint.tacc.utexas.edu/v1/problemStatements/{problemStatementId}/tasks/{taskId}/subtasks/{subtaskId}/blueprint?detailed=true" \
705
+
-H "Authorization: Bearer $JWT_TOKEN"
706
+
```
707
+
688
708
**Copy-paste ready:**
689
709
690
710
```
691
711
// 8. Verify Configuration - No request body needed (GET request)
712
+
// Add ?detailed=true for full parameter details
692
713
```
693
714
694
715
#### 9. Submit for Execution
@@ -796,6 +817,8 @@ curl -X POST "https://ensemble-manager.mint.tacc.utexas.edu/v1/problemStatements
796
817
- Always call the `/blueprint` endpoint after adding models
797
818
- The blueprint shows you exactly what parameters and inputs are available
798
819
- Use blueprint information to guide your parameter and data configuration
820
+
- Use `?detailed=true` to get comprehensive parameter metadata (type, description, min/max values, etc.)
821
+
- Default blueprint returns basic parameter info (id, value) for faster responses
0 commit comments