Update description on bearer auth #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
here is the result. |
bigsolom
reviewed
Aug 9, 2024
| - Oauth | ||
| description: | | ||
| Authenticate client ID and client secret to get access token | ||
| Get access token |
Contributor
There was a problem hiding this comment.
It's fine to keep the long line as it was it you want, redocly will display the whole line underneath the title anyway
| scheme: Bearer | ||
| description: get access token from oauth2 | ||
| scheme: bearer | ||
| description: | |
Contributor
There was a problem hiding this comment.
I would suggest to add a general description somewhere (maybe here) to how the whole authentication flow looks like
- getting uid and secret from client settings in app.fortytools.com
- getting access token from ...
- use this access token in each API request as a header
Authorization: Bearer .....
And by the way in case the toke expires, how would the client get a new token? should they call the same endpoint with client_id and client_secret again? Please document this as well
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add link to endpoint token so user know how to get access token.
add example to add to Authorization request header
removing client credential auth, because it will make user confuse.
ref: https://swagger.io/docs/specification/authentication/bearer-authentication/