Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add brackets around default URL parameters #2352

Open
amerritt14 opened this issue Apr 10, 2023 · 0 comments
Open

Add brackets around default URL parameters #2352

amerritt14 opened this issue Apr 10, 2023 · 0 comments
Labels
enhancement New feature or request portal triaged

Comments

@amerritt14
Copy link

Under the "Try It" request samples when there are URL parameters required in the endpoint, the current behavior is to substitute the URL parameter's name into the URL until a value is entered. Once the value is entered, the value is used instead.

When no value is entered, curly brackets should be included around the parameter's name to make it clear that the value should be replaced.

Context

Clarify the "Try It" code samples when no parameters have been entered.
Change from showing the endpoint url as https://api.example.com/users/userId to https://api.example.com/users/{userId}
Screenshot 2023-04-10 at 8 33 25 AM

Current Behavior

Currently if no details have been entered in the URL parameter, it shows the URL parameter's name in the URL.

Expected Behavior

The URL parameter would be wrapped in {} until the user inputs some value.

Possible Solution(s)

If this is a change that others feel is worthwhile, I'm happy to look into implementation details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request portal triaged
Projects
None yet
Development

No branches or pull requests

3 participants