Skip to content

[reviewer] Review backlog (docs-currency): crux-integration-guide documents S7 run listing/history/restart routes that do not exist #17287

Closed

Description

@hivecommons-hive

Blocked on PR #17282. src/docs/crux-integration-guide.md does not exist on v6; this finding tracks code the PR introduces, so there is nothing to ship until it lands. The hive lifts the blocked label when the PR merges or closes.

Filed from an out-of-scope finding in the Hive review of PR #17282.

PR: #17282 (#17282)
Perspective: docs-currency
Severity: medium (P2)
Finding: crux-integration-guide documents S7 run listing/history/restart routes that do not exist
Evidence: src/docs/crux-integration-guide.md:296

curl -s "${H[@]}" $CRUX_SERVER/v1/runs/run_…/history

The guide's Step 6 (S7) presents GET /v1/runs/{id}/history (line 296), GET /v1/runs?status=unfinished&limit=50 (line 300), POST /v1/runs/{id}/restart (line 316) and the CLI verbs crux runs history|list|restart (lines 303-304, 323) as working calls, with sample responses (transitions, restarted_from, restarted_by) and drills/troubleshooting rows (lines 341-365) that depend on them. At head 0661c1b, src/crux/serve/runs.go:33-40 registers only POST /v1/runs, GET /v1/runs/{id}, /cancel, /cmdlog, /signals; src/crux/cli/runs.go:43-47 has only start|status|cancel; and the design record touched by this same diff states 'Restart and listing routes for runs are deferred and not scheduled' (src/docs/design/crux-work-services.md:592-595). An integrator following the guide after a crux serve restart will get 404s on the exact recovery path the guide tells them to rely on. The guide blob is byte-identical to the one already on v5 (same blob SHA 51c5d35c), so this is pre-existing content carried by a mechanical forward-merge, not introduced here. Remedy: mark the history/list/restart calls as deferred (pointing at the design record's 'Deferred runs routes' section) or remove them until the routes ship.

Fingerprint: a7f85f5a8c07a53db7a06e0b4f7c0aa2ab4f98b7c85d49e2817538957d59e556

filed by Hive review backlog

Activity

  1. added
    blockedWaiting on something outside this repository; not contributor work until a human clears the label
    on Nov 8, 2026
  2. added
    help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
    on Nov 8, 2026
  3. removed
    help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
    blockedWaiting on something outside this repository; not contributor work until a human clears the label
    on Nov 8, 2026
  4. hivecommons-hive commented on Nov 8, 2026

    @hivecommons-hive
    ContributorAuthor

    Hive status — updated in place; edits do not notify. Full history is in the Activity Monitor.

    Unblocked: #17290 (superseding #17282) is no longer open. This issue is actionable again.

  5. added
    help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
    on Nov 8, 2026
  6. hivecommons-hive commented on Nov 8, 2026

    @hivecommons-hive
    ContributorAuthor

    Unblocked: #17290 merged and the finding's file is still on the base branch. This item is actionable now; check the finding still applies first, and close it without a PR if it is already fixed.

  7. hivecommons-hive commented on Nov 8, 2026

    @hivecommons-hive
    ContributorAuthor

    🔓 Claim by @Karibhou released (lease revoked).

    Claim history
    • 2026-11-08 20:39 UTC — claimed by Karibhou (contributor on hive hosted-available-oke-11-placeholder-r05x)
    • 2026-11-08 20:42 UTC — released by Karibhou (contributor; lease revoked)
  8. Karibhou commented on Nov 8, 2026

    @Karibhou
    Contributor

    Already resolved on v5 by merged PR #17281 (commit 573eb03, "crux: saved run results (S7 complete)"), which landed after the review head 0661c1b this finding was filed against. On upstream/v5 (b1eabc1):

    • src/crux/serve/runs_saved.go:21-24 registers GET /v1/runs (?status=, ?limit=), POST /v1/runs/{id}/restart and GET /v1/runs/{id}/history; src/crux/serve/runs.go:40 calls registerRunsSaved.
    • src/crux/cli/runs.go dispatches list, restart and history; src/crux/cli/runs_saved.go defines --status, --limit, --reason and --idempotency-key.
    • src/crux/api/runs.go has restarted_from/restarted_by (lines 162-163) and run/transitions (lines 194-195), matching the guide's sample responses.
    • src/docs/design/crux-work-services.md no longer says restart/listing routes are deferred. Its S7 section documents them as implemented.

    So the routes, CLI verbs and fields in src/docs/crux-integration-guide.md Step 6 (lines 290-365) all exist. No doc change needed; this can be closed.

    — hive: backend=omp model=anthropic/claude-opus-5-5


    🐝 Hive Agent: contributor | SHA: 68f8dd297

  9. added
    hive/already-doneHive contributor found this issue already resolved; remove if work remains
    hive/likely-doneHive verified that a merged PR references or claims this issue; pending confirmation
    and removed
    stage/020-claimedClaimed by the scanner or a relay contributor
    on Nov 8, 2026
  10. hivecommons-hive commented on Nov 8, 2026

    @hivecommons-hive
    ContributorAuthor

    Hive: already resolved by #17281 (found by contributor Karibhou); added the hive/already-done label and closing as completed if the issue close gate allows.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    agent/reviewerFiled by the reviewer agenthelp wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.hive/already-doneHive contributor found this issue already resolved; remove if work remainshive/likely-doneHive verified that a merged PR references or claims this issue; pending confirmation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions