fix(docs): Incorrectly mark Path Parameters as Query Parameters#41
Merged
sid-bruno merged 3 commits intoJun 12, 2026
Conversation
added 2 commits
June 10, 2026 18:12
sachin-bruno
force-pushed
the
sachin-bruno/fix-incorrect-path-paramters
branch
from
6e15ad2 to
23dfe1f
Compare
sid-bruno
changed the title
sid-bruno
requested changes
Jun 12, 2026
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
3 participants
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.
Problem
The interactive HTML documentation Bruno generates for a collection renders requests with Path parameters incorrectly in two related ways:
Path parameters appear under a "Query Parameters" heading — there is no Path Parameters section.
The displayed URL keeps its raw :placeholder segments, and the page's Try runner sends those segments verbatim. The server therefore receives GET /users/:username instead of GET /users/Billy, and echoes the literal placeholder back in the response ("Hello :username!").
Bruno itself handles the same request correctly inside the app (response: {"message": "Hello Billy!"}); only the generated documentation is wrong. Anyone consuming the docs is misled into thinking the API takes a query parameter named username instead of a path segment.
https://usebruno.atlassian.net/browse/BRU-3172