Azure / Azure/api-management-developer-portal

API console query parameter field to contain parameter description or example instead of "value"

Open
#973 0 comments 1 reaction 0 assignees View on GitHub
(t) Improvement (u) Usability P1
Dominant language
TypeScript
Stars
545
Forks
360
PR merge metrics
No merged PRs in 30d

Description

Feature-request

When opening API Console all input fields have gray-out text ```value```:
![image](https://user-images.githubusercontent.com/17021450/96090156-7b53ad80-0ed0-11eb-8877-97817eb1cc10.png)

It would be more user friendly to have parameter description or parameter example instead. This kind of approach is in Swagger UI:
![image](https://user-images.githubusercontent.com/17021450/96090010-4b0c0f00-0ed0-11eb-8888-87c415772501.png)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the API Console entry point and locate the rendering for query-parameter input fields. Check how parameter descriptions and examples are exposed there, then make the placeholder show that metadata instead of "value". Done means the console displays the description or example for applicable parameters; verify the behavior in the API Console.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.