ruby-grape / ruby-grape/grape-swagger
Password input field
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
My api has an endpoint to authenticate users and get a token via authentication of email and password. I know the swagger spec supports specifying a password format and swagger-ui will turn the input into a password. However, I'm not sure if this is a swagger 2.0 spec feature or not.
is it possible to specify in grape-swagger that a parameter is a password parameter yielding a password input in swagger-ui?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how grape-swagger generates Swagger 2.0 parameters for the email-and-password authentication endpoint and compare the available password format or input metadata with swagger-ui behavior. Confirm whether the generated specification can cause the password field to render as masked, and consider the work done when that behavior is supported and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, ruby
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100