Repository navigation
devproxy api show: include request body and query parameters for each endpoint - #2092
Open
waldekmastykarz wants to merge 1 commit into
Open
waldekmastykarz wants to merge 1 commit into
waldekmastykarz wants to merge 1 commit into
Conversation
… endpoint Closes dotnet#2065 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues were identified in the endpoint input-hint changes.
No open issues 🎉
What changed in this PR
Enhances devproxy api show with endpoint input hints so users and agents can discover expected request bodies and query parameters.
Changes:
- Adds body and query hints to text output and optional
bodyandqueryfields to JSON output. - Centralizes endpoint metadata and text formatting.
- Adds tests for recording, certificate, and JWT hints, plus endpoints without input.
| File | Description |
|---|---|
DevProxy/Commands/ApiCommand.cs |
Defines input hints and includes them in text and JSON output. |
DevProxy.Tests/ApiCommandTests.cs |
Tests endpoint hints and description-only formatting. |
Review effort: Balanced
waldekmastykarz
added a commit
to waldekmastykarz/dev-proxy
that referenced
this pull request
Nov 5, 2026
- Rename structured query field to OpenAPI 'parameters' (with in: query) so it doesn't collide with the 'query' hint added in dotnet#2092 - Disallow additional properties in the POST /proxy request schema - Document 400 for invalid query values on /proxy/logs Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #2065
devproxy api shownow lists the input each endpoint expects, so agents don't have to guess thePOST /proxybody or miss the requiredformatquery on/proxy/rootCertificate.Text output:
JSON output (
--output json) gets matching optionalqueryandbodystring hints per endpoint (omitted when an endpoint takes no input).Notes:
Docs: https://go.devproxy.net?go=apiline from the proposal is left to Print canonical docs shortlinks in--help,api show, and plugin errors #2063, which introduces the shortlinks.devproxy api show --output json: include request and response schemas, or serve an OpenAPI document #2066.