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: requireVerification=true does accept password #2980

Conversation

martijnvdbrug
Copy link
Collaborator

@martijnvdbrug martijnvdbrug commented Jul 30, 2024

Description

The requireVerification docs are conflicting with the registerCustomerAccount docs

Checklist

📌 Always:

  • I have set a clear title
  • My PR is small and contains a single feature
  • I have checked my own PR

👍 Most of the time:

  • I have added or updated test cases
  • I have updated the README if needed

Copy link

vercel bot commented Jul 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Jul 30, 2024 10:19am

* `password` property - doing so will result in an error. Instead, the password is set at a later stage
* (once the email with the verification token has been opened) via the `verifyCustomerAccount` mutation.
* If set to "true", the customer will be required to verify their email address using a verification token
* they receive in their email. See {@link registerCustomerAccount}.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Does this @link work when linking to a mutation?

Copy link
Member

Choose a reason for hiding this comment

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

No, because the TS compiler does not know about the graphql schema.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ahh ok, I though it was a higher level tool that resolved these links on the docs website. Will remove it

@michaelbromley michaelbromley merged commit ccdcc86 into vendure-ecommerce:master Jul 31, 2024
14 checks passed
@michaelbromley
Copy link
Member

Thanks!

@github-actions github-actions bot locked and limited conversation to collaborators Jul 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants