Skip to content

feat(executions): add result_ref kwarg to report_outcome#19

Closed
govindkavaturi-art wants to merge 1 commit intomainfrom
feat/result-ref-kwarg
Closed

feat(executions): add result_ref kwarg to report_outcome#19
govindkavaturi-art wants to merge 1 commit intomainfrom
feat/result-ref-kwarg

Conversation

@govindkavaturi-art
Copy link
Copy Markdown
Member

Single-line kwarg addition to the SDK's report_outcome so callers can pass result_ref (already supported server-side per OutcomeRequest in the main cueapi monorepo's app/schemas/outcome.py).

Companion to the cueapi-worker 0.3.0 PR in cueapi/cueapi, which adds the same field to its internal WorkerAPIClient so the new CUEAPI_OUTCOME_FILE pattern can surface result_ref.

  • Optional kwarg, defaults to None
  • Forwarded to POST body only when provided
  • No behavior change for existing callers
  • Unit test coverage already exercises the report_outcome happy path with mocked HTTP; result_ref is plumbed identically to external_id/result_type/summary/artifacts

No version bump here — Argus cuts the SDK tag on its own after the monorepo bits land.

The server's /v1/executions/{id}/outcome endpoint already accepts a
`result_ref` evidence field (see OutcomeRequest in cueapi/cueapi
app/schemas/outcome.py). The SDK's report_outcome was missing it,
forcing callers who want to attach a reference ID to fall back to
either raw HTTP or using an unrelated field like external_id.

Single-line addition in executions.py: new kwarg, forwarded to the
POST body when provided, same shape as every other evidence field.

Companion change in cueapi-worker 0.3.0 (monorepo PR in cueapi/cueapi)
exposes the same field on its WorkerAPIClient so worker-transport
handlers can surface result_ref via the new CUEAPI_OUTCOME_FILE
pattern.

No behavioral change for existing callers — kwarg is optional and
defaults to None.
@govindkavaturi-art
Copy link
Copy Markdown
Member Author

Closing as already-shipped. result_ref was already merged to main via commit 156ed37 (v0.1.3) and is live on PyPI as part of cueapi-sdk 0.1.3 — visible at cueapi/resources/executions.py lines 61, 78-79. This PR would reintroduce the same three lines. No change needed.

Verified:

  • grep -n result_ref cueapi/resources/executions.py on origin/main returns the lines already in place.
  • pip index versions cueapi-sdk shows 0.1.3 as latest (published 2026-04-15).

Flagging as a parity artifact — no gap, no work needed.

@govindkavaturi-art govindkavaturi-art deleted the feat/result-ref-kwarg branch April 19, 2026 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant