Enhance reCAPTCHA documentation to include support for reCAPTCHA Enterprise#787
Open
Enhance reCAPTCHA documentation to include support for reCAPTCHA Enterprise#787
Conversation
…rprise, update integration steps, and clarify usage guidelines for custom forms. Add caution regarding mixed reCAPTCHA types and improve overall structure for better clarity.
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
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.
Purpose of this pull request
This pull request rewrites the reCAPTCHA integration documentation to reflect the addition of reCAPTCHA Enterprise support introduced in StorefrontSDK PR #189. The existing docs were outdated — they stated only v3 was supported, showed incorrect
setConfigusage (passing a config object instead of aPropsFormTypes[]array), and lacked guidance for Enterprise, custom forms, and debugging.Key changes:
setConfigAPI documentation — correctly documents thePropsFormTypes[]signature and clarifies thatconfigListentries are additive badge containers, not backend config overridessetEndpoint→setConfig→initReCaptcha→verifyReCaptchainitReCaptchadelay parameter documentation (lazyLoadTimeout, default 3000ms)enableLoggersection with[ReCaptcha]prefix details and lifecycle coveragewebsite_keyhandling, future per-form type support)Associated JIRA ticket
Staging preview
Affected pages
Links to source code
What's New highlights
recaptchaFormConfigGraphQL endpoint and loads the appropriate Google script (api.jsorenterprise.js). No changes required for existing v3 integrations.