swagger-api / swagger-api/swagger-codegen
[bash] OAuth2 authentication method documentation
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
The documentation concerning oauth2 documentation is not clear.
Swagger-codegen version
2.2.3
Suggest a fix/enhancement
Running swagger-codegen and the resulting tool leaves an output like
Authentication methods
- Api-key - add 'api_key:<api-key>' after <operation>
or export PETSTORE_API_KEY='<api-key>'
- OAuth2 (flow: implicit)
Authorization URL:
* http://petstore.swagger.io/oauth/dialog
Scopes:
* write:pets - modify pets in your account
* read:pets - read your pets
which does not help me understand on how to use the OAuth2 authentication method in order to call the resp. operations. I do still not know wether its possible or not, and if how, to configure and use the OAuth2 authentication with the bash client.
Please enhance documentation, even by (if applicable) saying that there is no intrinsic generated way to handle it or something like this!
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 reproducing the Swagger-codegen 2.2.3 output for the bash client and reviewing the displayed OAuth2 implicit-flow authentication information. Document whether the generated bash client supports configuring and using OAuth2 for operations, including the relevant setup steps, or clearly state if no intrinsic generated support exists.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash
- Domain
- authentication, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100