Skip to content

Commit 4e81465

Browse files
committed
updating docs
1 parent 8b33480 commit 4e81465

File tree

3 files changed

+25
-24
lines changed

3 files changed

+25
-24
lines changed

docs/architecture/core_structures.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -245,30 +245,31 @@ class PipelineExecution:
245245
start_time: float # Execution start timestamp
246246
```
247247

248-
### Methods
248+
### Pipeline Execution Summary
249249

250-
```python
251-
def get_pipeline_execution_summary() -> dict:
252-
"""
253-
Generate detailed summary for API responses.
254-
255-
Returns:
250+
The `PipelineExecutionSerializer` (`autograder/serializers/pipeline_execution_serializer.py`) handles the conversion of an execution into a dictionary for API responses.
251+
252+
#### `PipelineExecutionSerializer.serialize(execution) -> dict`
253+
254+
Generates detailed summary for API responses.
255+
256+
**Returns:**
257+
```json
258+
{
259+
"status": "success" | "failed",
260+
"failed_at_step": str | None,
261+
"total_steps_planned": int,
262+
"steps_completed": int,
263+
"execution_time_ms": int,
264+
"steps": [
256265
{
257-
"status": "success" | "failed",
258-
"failed_at_step": str | None,
259-
"total_steps_planned": int,
260-
"steps_completed": int,
261-
"execution_time_ms": int,
262-
"steps": [
263-
{
264-
"name": "PRE_FLIGHT",
265-
"status": "success" | "fail",
266-
"message": str,
267-
"error_details": dict | None # Present if step failed
268-
}
269-
]
266+
"name": "PreFlightStep",
267+
"status": "success" | "fail",
268+
"message": str,
269+
"error_details": dict | None # Present if step failed
270270
}
271-
"""
271+
]
272+
}
272273
```
273274

274275
### Example Summary (Success)

docs/guides/github_module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In short, the adopted solution consists of running a Docker container with the d
1717
1. [Action.yml](../../action.yml)
1818
Defines the inputs received by the action, describes the output as a JSON evaluation, and runs the container with the received data as environment variables.
1919

20-
2. [Dockerfile](../../github_action/Dockerfile.actions)
20+
2. [Dockerfile](../../Dockerfile.actions)
2121
Builds the container that installs the Autograder repository and sets [Entrypoint.sh](../../github_action/entrypoint.sh) as the script to be executed when the container starts.
2222

2323
3. [Entrypoint.sh](../../github_action/entrypoint.sh)

docs/pipeline/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ EMPTY ──▶ RUNNING ──▶ SUCCESS
7171
- `has_step_result(step_name)` — Checks if a step was executed.
7272
- `get_previous_step()` — Returns the most recently added step result.
7373
- `finish_execution()` — Assembles the `GradingResult` from the GRADE, FOCUS, and FEEDBACK step results if the pipeline succeeded.
74-
- `get_pipeline_execution_summary()` — Generates a structured dictionary for API responses with step details, timing, and error information.
74+
- `PipelineExecutionSerializer.serialize(execution)` — Generates a structured dictionary for API responses with step details, timing, and error information.
7575

7676
### StepResult
7777

@@ -197,7 +197,7 @@ When a step fails:
197197

198198
For unhandled exceptions, the status is set to `INTERRUPTED` and the same cleanup logic applies.
199199

200-
The `PipelineExecution` object provides `get_pipeline_execution_summary()` for structured error reporting in API responses. See [Pipeline Execution Tracking](../architecture/pipeline_execution_tracking.md) for details on how this surfaces in the API.
200+
The `PipelineExecutionSerializer` provides structured error reporting in API responses. See [Pipeline Execution Tracking](../architecture/core_structures.md#pipeline-execution-summary) for details on how this surfaces in the API.
201201

202202
---
203203

0 commit comments

Comments
 (0)