Skip to content

Commit b19b209

Browse files
committed
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.
1 parent e1ba321 commit b19b209

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,11 +294,16 @@ GET /problemStatements/{problemStatementId}/tasks/{taskId}/subtasks/{subtaskId}
294294
**Get Blueprint for a Subtask**
295295

296296
```http
297-
GET /problemStatements/{problemStatementId}/tasks/{taskId}/subtasks/{subtaskId}/blueprint
297+
GET /problemStatements/{problemStatementId}/tasks/{taskId}/subtasks/{subtaskId}/blueprint?detailed={boolean}
298298
```
299299

300300
This endpoint returns the complete model configuration blueprint for all models in a subtask, showing available parameters and data inputs.
301301

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+
302307
## Programmatic Workflow Guide
303308

304309
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/
447452
-H "Authorization: Bearer $JWT_TOKEN"
448453
```
449454

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+
450462
**Copy-paste ready:**
451463

452464
```
453465
// 5. Get Blueprint - No request body needed (GET request)
466+
// Add ?detailed=true for full parameter details
454467
```
455468

456469
**Example Blueprint Response:**
@@ -685,10 +698,18 @@ curl -X GET "https://ensemble-manager.mint.tacc.utexas.edu/v1/problemStatements/
685698
-H "Authorization: Bearer $JWT_TOKEN"
686699
```
687700

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+
688708
**Copy-paste ready:**
689709

690710
```
691711
// 8. Verify Configuration - No request body needed (GET request)
712+
// Add ?detailed=true for full parameter details
692713
```
693714

694715
#### 9. Submit for Execution
@@ -796,6 +817,8 @@ curl -X POST "https://ensemble-manager.mint.tacc.utexas.edu/v1/problemStatements
796817
- Always call the `/blueprint` endpoint after adding models
797818
- The blueprint shows you exactly what parameters and inputs are available
798819
- 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
799822

800823
#### Parameter Values
801824

0 commit comments

Comments
 (0)