5a480a3c2a
Some checks failed
Reachability Corpus Validation / validate-corpus (push) Waiting to run
Reachability Corpus Validation / validate-ground-truths (push) Waiting to run
Reachability Corpus Validation / determinism-check (push) Blocked by required conditions
Scanner Analyzers / Discover Analyzers (push) Waiting to run
Scanner Analyzers / Build Analyzers (push) Blocked by required conditions
Scanner Analyzers / Test Language Analyzers (push) Blocked by required conditions
Scanner Analyzers / Validate Test Fixtures (push) Waiting to run
Scanner Analyzers / Verify Deterministic Output (push) Blocked by required conditions
Signals CI & Image / signals-ci (push) Waiting to run
Signals Reachability Scoring & Events / reachability-smoke (push) Waiting to run
Signals Reachability Scoring & Events / sign-and-upload (push) Blocked by required conditions
AOC Guard CI / aoc-guard (push) Has been cancelled
AOC Guard CI / aoc-verify (push) Has been cancelled
Docs CI / lint-and-preview (push) Has been cancelled
Export Center CI / export-ci (push) Has been cancelled
Findings Ledger CI / build-test (push) Has been cancelled
Findings Ledger CI / migration-validation (push) Has been cancelled
Findings Ledger CI / generate-manifest (push) Has been cancelled
Lighthouse CI / Lighthouse Audit (push) Has been cancelled
Lighthouse CI / Axe Accessibility Audit (push) Has been cancelled
Policy Lint & Smoke / policy-lint (push) Has been cancelled
- Introduced `all-edge-reasons.json` to test edge resolution reasons in .NET. - Added `all-visibility-levels.json` to validate method visibility levels in .NET. - Created `dotnet-aspnetcore-minimal.json` for a minimal ASP.NET Core application. - Included `go-gin-api.json` for a Go Gin API application structure. - Added `java-spring-boot.json` for the Spring PetClinic application in Java. - Introduced `legacy-no-schema.json` for legacy application structure without schema. - Created `node-express-api.json` for an Express.js API application structure.
2.5 KiB
2.5 KiB
Orchestrator · First Signal API
Provides a fast “first meaningful signal” for a run (TTFS), with caching and ETag-based conditional requests.
Endpoint
GET /api/v1/orchestrator/runs/{runId}/first-signal
Required headers
X-Tenant-Id: tenant identifier (string)
Optional headers
If-None-Match: weak ETag from a previous 200 response (supports multiple values)
Responses
200 OK
Returns the first signal payload and a weak ETag.
Response headers:
ETag: weak ETag (forIf-None-Match)Cache-Control: private, max-age=60Cache-Status: hit|missX-FirstSignal-Source: snapshot|cold_start(best-effort diagnostics)
Body (application/json):
{
"runId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"firstSignal": {
"type": "started",
"stage": "unknown",
"step": null,
"message": "Run started",
"at": "2025-12-15T12:00:10+00:00",
"artifact": { "kind": "run", "range": null }
},
"summaryEtag": "W/\"...\""
}
204 No Content
Run exists but no signal is available yet (e.g., run has no jobs).
304 Not Modified
Returned when If-None-Match matches the current ETag.
404 Not Found
Run does not exist for the resolved tenant.
400 Bad Request
Missing/invalid tenant header or invalid parameters.
ETag semantics
- Weak ETags are computed from a deterministic, canonical hash of the stable signal content.
- Per-request diagnostics (e.g., cache hit/miss) are intentionally excluded from the ETag material.
Streaming (SSE)
The run stream emits first_signal events when the signal changes:
GET /api/v1/orchestrator/stream/runs/{runId}
Event type:
first_signal
Payload shape:
{
"runId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"etag": "W/\"...\"",
"signal": { "version": "1.0", "signalId": "...", "jobId": "...", "timestamp": "...", "kind": 1, "phase": 6, "scope": { "type": "run", "id": "..." }, "summary": "...", "etaSeconds": null, "lastKnownOutcome": null, "nextActions": null, "diagnostics": { "cacheHit": false, "source": "cold_start", "correlationId": "" } }
}
Configuration
appsettings.json:
{
"FirstSignal": {
"Cache": {
"Backend": "inmemory",
"TtlSeconds": 86400,
"SlidingExpiration": true,
"KeyPrefix": "orchestrator:first_signal:"
},
"ColdPath": {
"TimeoutMs": 3000
},
"SnapshotWriter": {
"Enabled": false,
"TenantId": null,
"PollIntervalSeconds": 10,
"MaxRunsPerTick": 50,
"LookbackMinutes": 60
}
},
"messaging": {
"transport": "inmemory"
}
}