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

Aberta
#2,081 0 comentários 0 reações 1 responsável Ver no GitHub

Mantenedores costumam responder em até 1 dia

@waldekmastykarz já está trabalhando nisso.

Desde 5/11/2026.

Avaliação

Esta issue ainda não foi avaliada.

Descrição

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

Linguagem predominante
C#
Estrelas
841
Forks
90
Merge médio
2d 10h
PRs com merge (30d)
63

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de dotnet/dev-proxy

Todas as issues de dotnet/dev-proxy

Issues semelhantes

Mais issues de C#

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.