Document the shutdown contract for `POST /proxy/stopProxy`

Offen
#2,081 0 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@waldekmastykarz arbeitet bereits daran.

Seit 05.11.2026.

Bewertung

Dieses Issue wurde noch nicht bewertet.

Beschreibung

documentation work in progress

Problem

The Proxy API page says only "Gracefully shuts down Dev Proxy" and returns 202 Accepted. It doesn't say:

  • whether recording is stopped and reports are written before exit,
  • that system proxy and certificate changes are reverted,
  • how long shutdown typically takes and what exit code to expect,
  • how a script knows Dev Proxy has exited. The CI/CD overview suggests grepping the log for DONE, but that's not linked from here.

Without this, every agent-written script added a 15–30 s wait and a kill fallback. Killing the process skips cleanup.

Proposal

Under POST /proxy/stopproxy, document what happens on shutdown and in what order, plus the recommended way to wait for exit. Examples: wait on the PID returned by --detach, poll devproxy status --pid <pid>, or check the log for DONE. Note that the API is no longer reachable once shutdown starts.

Found while evaluating how coding agents use Dev Proxy: VS Code + GitHub Copilot Chat with Claude Sonnet 5.5, Dev Proxy 4.0.0 on Windows, 5 runs of the task "add a CI script that starts Dev Proxy in the background, starts and stops recording through the API around npm start, and shuts Dev Proxy down through the API".

Vorherrschende Sprache
C#
Sterne
841
Forks
90
Ø Merge
2 T. 10 Std.
Gemergte PRs (30 T.)
63

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus dotnet/dev-proxy

Alle Issues in dotnet/dev-proxy

Ähnliche Issues

Weitere Issues zu C#

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.