swagger-api / swagger-api/swagger-codegen
[Documentation] Authorization argument format
Open
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
Authorization argument format
There is an generator argument [(-a | --auth )], which is poorly described in README.
Could you please extend a documentation? It is not obvious that login:pass shoud be Base64 encoded.
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 in the README documentation for the generator arguments, locating the description of -a and --auth . Clarify the expected login:pass encoding there, and consider the work done when the README makes this format unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100