swagger-api / swagger-api/swagger-ui

Remove 'string' text for string parameters

Open
#8,195 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Content

For string type parameters, when adding a value, I need to remove "string" from the textbox first. If I don't then "string" is passed as a parameter.
Clients have found this confusing/frustrating.
Can it be set as hint text, similar to integer parameters?

image

Is your feature request related to a problem?
Describe the solution you'd like
Describe alternatives you've considered
Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the Swagger UI frontend for the control that renders inputs for string-type parameters, then compare it with the existing integer-parameter hint behavior. The work is done when “string” appears as hint text rather than a submitted value, and the relevant parameter-input behavior is verified.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.