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(provider): scope expects space separated string #2188

Merged
merged 4 commits into from
Jun 16, 2021

Conversation

Cryt1c
Copy link
Contributor

@Cryt1c Cryt1c commented Jun 15, 2021

Reasoning 💡

Currently the docs list string[] as a possible type for scope.
However, It only accepts a string (with space as separator).

scope

Checklist 🧢

  • Documentation
  • Ready to be merged

Affected issues 🎟

ndom91 and others added 3 commits June 12, 2021 16:42
Currently the docs list string[] as possible type for scope. 
However, It only accepts a string (with space as separator).
@vercel
Copy link

vercel bot commented Jun 15, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/nextauthjs/next-auth/7bALCHjhgh2SGukGFrCtJtxnfr8u
✅ Preview: https://next-auth-git-fork-cryt1c-patch-1-nextauthjs.vercel.app

@vercel vercel bot temporarily deployed to Preview June 15, 2021 11:26 Inactive
@github-actions github-actions bot added documentation Relates to documentation providers labels Jun 15, 2021
@balazsorban44 balazsorban44 changed the base branch from main to next June 15, 2021 21:51
@balazsorban44
Copy link
Member

Thanks for the PR! I went down the rabbit hole to find the reasoning and what I found is that at the end of the day, string[] is supported in a way by our parser that translates the scope to a url query parameter, but in a wrong way that probably some oauth providers wouldn't support. See

https://nodejs.org/api/querystring.html#querystring_querystring_stringify_obj_sep_eq_options

So I'm happy to accept this PR! one thing I changed is the PR target branch. We are working on our next major release, and so any non-critical changes will preferably be made in the next branch. This is only temporary, so I don't wish to change our contribution docs on that.

What that means for you that until v4 docs is officially out, this change will only be visible at https://next-auth-git-next-nextauthjs.vercel.app/ for now. Hope it's not a problem for you!

@balazsorban44 balazsorban44 changed the title fix(docs): scope expects space separated string docs(provider): scope expects space separated string Jun 15, 2021
@balazsorban44 balazsorban44 self-assigned this Jun 15, 2021
@vercel vercel bot temporarily deployed to Preview June 16, 2021 05:18 Inactive
@Cryt1c
Copy link
Contributor Author

Cryt1c commented Jun 16, 2021

Thanks for your review!
Makes sense. 👍 I have resolved all merge conflicts.

@balazsorban44
Copy link
Member

I was going to, but thank you! 😁

@balazsorban44 balazsorban44 merged commit bbc2d9b into nextauthjs:next Jun 16, 2021
mnphpexpert added a commit to mnphpexpert/next-auth that referenced this pull request Sep 2, 2024
* fix(docs): scope expects space separated string

Currently the docs list string[] as possible type for scope. 
However, It only accepts a string (with space as separator).

Co-authored-by: Balázs Orbán <info@balazsorban.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to documentation providers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants