fix: add after_verification_return_to to sdk and api docs (#3097)

Closes #3096
ory · Feb 13, 2023 · c70704c · c70704c
1 parent a542164
commit c70704c
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 8 deletions.
diff --git a/internal/client-go/api_frontend.go b/internal/client-go/api_frontend.go
diff --git a/internal/httpclient/api_frontend.go b/internal/httpclient/api_frontend.go
diff --git a/selfservice/flow/registration/handler.go b/selfservice/flow/registration/handler.go
@@ -219,6 +219,16 @@ type createBrowserRegistrationFlow struct {
 	// required: false
 	// in: query
 	LoginChallenge string `json:"login_challenge"`
+
+	// The URL to return the browser to after the verification flow was completed.
+	//
+	// After the registration flow is completed, the user will be sent a verification email.
+	// Upon completing the verification flow, this URL will be used to override the default
+	// `selfservice.flows.verification.after.default_redirect_to` value.
+	//
+	// required: false
+	// in: query
+	AfterVerificationReturnTo string `json:"after_verification_return_to"`
 }
 
 // swagger:route GET /self-service/registration/browser frontend createBrowserRegistrationFlow

diff --git a/spec/api.json b/spec/api.json
@@ -5458,6 +5458,14 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "description": "The URL to return the browser to after the verification flow was completed.\n\nAfter the registration flow is completed, the user will be sent a verification email.\nUpon completing the verification flow, this URL will be used to override the default\n`selfservice.flows.verification.after.default_redirect_to` value.",
+            "in": "query",
+            "name": "after_verification_return_to",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {

diff --git a/spec/swagger.json b/spec/swagger.json
@@ -2061,6 +2061,12 @@
             "description": "Ory OAuth 2.0 Login Challenge.\n\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.\n\nThe value for this parameter comes from `login_challenge` URL Query parameter sent to your\napplication (e.g. `/registration?login_challenge=abcde`).\n\nThis feature is compatible with Ory Hydra when not running on the Ory Network.",
             "name": "login_challenge",
             "in": "query"
+          },
+          {
+            "type": "string",
+            "description": "The URL to return the browser to after the verification flow was completed.\n\nAfter the registration flow is completed, the user will be sent a verification email.\nUpon completing the verification flow, this URL will be used to override the default\n`selfservice.flows.verification.after.default_redirect_to` value.",
+            "name": "after_verification_return_to",
+            "in": "query"
           }
         ],
         "responses": {