From a64d075618cc04f7b2ee7f4e12f1ab4e0f542a26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20=C4=8Ciha=C5=99?= Date: Tue, 23 Jun 2026 19:45:24 +0200 Subject: [PATCH] docs: clarify external partial resume confirmation --- .gitignore | 1 + docs/pipeline.rst | 18 +++++++++--------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 7c2001d4..74a2537a 100644 --- a/.gitignore +++ b/.gitignore @@ -49,3 +49,4 @@ changelog.sh \#*\# .python-version +uv.lock diff --git a/docs/pipeline.rst b/docs/pipeline.rst index cf4c8051..13d6af57 100644 --- a/docs/pipeline.rst +++ b/docs/pipeline.rst @@ -348,11 +348,12 @@ only for those flows:: def my_external_validation(strategy, backend, current_partial=None, **kwargs): ... -Externally resumed partials do not resume immediately when the link is opened in -a different browser session. The first request stores pending resume state in -the current browser session and asks the Strategy to render a local confirmation -response. A later confirmation request from the same browser resumes the -pipeline and replays the original link request data in ``kwargs['request']``. +Externally resumed partials do not resume immediately when a request supplies +the partial token, even in the browser session that created the partial. The +first request stores pending resume state in the current browser session and +asks the Strategy to render a local confirmation response. A later confirmation +request from the same browser resumes the pipeline and replays the original +link request data in ``kwargs['request']``. The confirmation request must include the parameter configured by ``SOCIAL_AUTH_PARTIAL_PIPELINE_EXTERNAL_RESUME_CONFIRMATION_PARAMETER``. The @@ -406,10 +407,9 @@ function should take four arguments ``strategy``, ``backend``, ``code`` and that can be used to restart a halted flow. The built-in mail validation step is an externally resumable partial. Opening -the validation link from a different browser session will first show the local -confirmation response provided by the active Strategy. After confirmation, the -pipeline receives the original ``verification_code`` and ``partial_token`` in -``kwargs['request']``. +the validation link will first show the local confirmation response provided by +the active Strategy. After confirmation, the pipeline receives the original +``verification_code`` and ``partial_token`` in ``kwargs['request']``. ``code`` is a model instance used to validate the email address, it contains three fields: