Skip to main content
← Back to list
01Issue
FeatureOpenSwamp CLIPublic
AssigneesNone

Relationships

#1741 Docs: update cancel endpoint response statuses in REST API reference and workflows page

Opened by stack72 · 8/20/2026

What changed

The cancel endpoint (POST /api/v1/cancel/:type/:id) now returns two possible success statuses instead of one:

  • cancelled — the run was confirmed stopped (deregistered within the grace period)
  • cancellation_requested — abort signal delivered but the run is still active

The bulk cancel endpoint (POST /api/v1/cancel) now returns cancellation_requested instead of cancelled.

Pages to update (in swamp-club/swamp-club)

  1. content/manual/reference/swamp-serve/rest-api.md — update the response tables for both cancel endpoints to document the new cancellation_requested status and the grace-period behavior
  2. content/manual/reference/workflows.md — the swamp workflow cancel section should note the --server flag behavior change (now distinguishes confirmed vs requested cancellation)

Context

Fixes the documentation side of #1738 (cancel endpoint was reporting status: cancelled for runs it didn't actually cancel).


Automoved by swampadmin from https://github.com/swamp-club/swamp/issues/2190

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED

Open

8/20/2026, 12:09:25 AM

No activity in this phase yet.

03Sludge Pulse

Sign in to post a ripple.