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

Đang mở
#2,081 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@waldekmastykarz đang làm issue này rồi.

Từ ngày 5/11/2026.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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

Ngôn ngữ chính
C#
Star
841
Fork
90
Merge trung bình
2 ngày 10 giờ
Pull request đã merge (30 ngày)
63

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của dotnet/dev-proxy

Tất cả issue của dotnet/dev-proxy

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.