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

Aperta
#2,081 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@waldekmastykarz ci sta già lavorando.

Dal 5/11/2026.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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".

Lingua principale
C#
Stelle
841
Fork
90
Merge medio
2g 10h
PR unite (30g)
63

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di dotnet/dev-proxy

Tutte le issue di dotnet/dev-proxy

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.