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

Update create-team-membership.md #5014

Merged

Conversation

gewenyu99
Copy link

What does this PR do?

(Provide a description of what this PR does.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you added your change to the Changelog?

(The CHANGES.md file tracks all the changes that make it to the main branch. Add your change to this file in the following format)

  • One line description of your PR [#pr_number](Link to your PR)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)


You can only provide one of the User ID, email or phone number to add member to the team. And the priority will be User ID > email and > phone number.
You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.
Copy link
Member

Choose a reason for hiding this comment

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

when more than one parameter is provided, we also check to verify it matches, for example if userID and email is provided, then we check if the user with that userID has the same email, and throw exception otherwise. Can we add this info somehow, same for email and phone with priority over email.

Copy link
Author

Choose a reason for hiding this comment

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

Maybe we don't need this information. I think, practically speaking, it shouldn't make a difference. I think getting an error is enough cause this only happens when they make a mistake.

If we need to document this:

Suggested change
You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.
You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters. If more than one parameter is provided, Appwrite will verify if the user ID matches the provided email or phone and throw an error otherwise.

Copy link
Member

Choose a reason for hiding this comment

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

I'll leave the final decision to @eldadfux ?

Copy link
Member

Choose a reason for hiding this comment

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

Agree with @gewenyu99. We provide enough information, we can reconsider if we see this becomes a popular error. @gewenyu99 might be good to monitor our error stats on Sentry as part of our DX workflows, and try to detect problematic places in the dev-journey.

Copy link
Member

Choose a reason for hiding this comment

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

okay

@lohanidamodar lohanidamodar merged commit b3481e0 into feat-team-invite-improvements Jan 23, 2023
@lohanidamodar lohanidamodar deleted the gewenyu99-patch-team-invite-doc branch January 23, 2023 08:17
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.

None yet

3 participants