Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README.md with revised information #207

Merged
merged 4 commits into from
Jun 5, 2023

Conversation

rojandahal
Copy link
Contributor

@rojandahal rojandahal commented May 31, 2023

The documentation (https://github.com/fastify/fastify-oauth2/blob/master/README.md?plain=1#L230) explained that the refresh token required is actual refresh token.

But the refresh token passed to simple-oauth2 's .createToken() method expects the Access Token object with refresh token itself.

So the documentation is edited to explain that the .getNewAccessTokenUsingRefreshToken() method required AccessToken object which is of format {refresh_token: 'eyJhbGciOiJSUzI1NiI...'})

Checklist

The documentation (https://github.com/fastify/fastify-oauth2/blob/master/README.md?plain=1#L230) explained that the refresh token required is actual refresh token. 

But the refresh token passed to simple-oauth2 's .createToken() method expects the Access Token object with refresh token itself.
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
rojandahal and others added 2 commits May 31, 2023 22:16
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Uzlopak Uzlopak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does not seem right

@rojandahal rojandahal requested a review from Uzlopak June 1, 2023 18:33
Co-authored-by: Rojan Dahal <[email protected]>
Copy link
Contributor

@Uzlopak Uzlopak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. :)

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mcollina mcollina merged commit e8df9dc into fastify:master Jun 5, 2023
@mcollina
Copy link
Member

mcollina commented Jun 5, 2023

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants