Add path variables documentation for HTTP client#29
Conversation
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds documentation for the HTTP client’s new “path variables” feature, explaining :variableName URL segments and how to populate them via the Params UI.
Changes:
- Added a new “Path Variables” documentation section with an end-to-end example.
- Documented automatic extraction of
:variableNamesegments into the Params tab UI.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Key | Value | Description | | ||
| |-----|-------|-------------| | ||
| | userId | 123 | The user's unique identifier | | ||
| | postId | 456 | The post's unique identifier | |
There was a problem hiding this comment.
The table syntax uses double leading pipes (|| ...), which is not standard Markdown and may not render as a table in MDX/Mintlify. Update it to standard table formatting (single leading/trailing | per row) so it reliably renders in the docs.
| ## Path Variables | ||
|
|
||
| Path variables allow you to define dynamic segments in your API URL using the `:variableName` syntax. This is useful for RESTful APIs where resource identifiers are part of the URL path. | ||
|
|
There was a problem hiding this comment.
Consider adding a language identifier (e.g., text) to fenced code blocks to ensure consistent rendering/highlighting in MDX across environments.
1 participant
This PR adds documentation for the new path variables feature in the HTTP client. Users can now define dynamic URL paths using
:variableNamesyntax and set values through the Params tab interface.Files changed
general/api-client/send-api-request.mdx- Added path variables section with usage examples and interface detailsCreated by Mintlify agent