diff --git a/CHANGELOG.md b/CHANGELOG.md index 3a7d426..c310154 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) +## [3.1.0] - 2024-10-18 + +### Changes + +- Added an optional `shouldTryLinkingWithSessionUser` to sign in/up related APIs: + - `EmailPassword.signInPOST`: `POST /{apiBasePath}//signin` + - `EmailPassword.signUpPOST`: `POST /{apiBasePath}//signup` + - `ThirdParty.signInUpPOST`: `POST /{apiBasePath}//signinup` + - `Passwordless.createCodePOST`: `POST /{apiBasePath}//signinup/code` + - `Passwordless.consumeCodePOST`: `POST /{apiBasePath}//signinup/code/consume` + - `Passwordless.resendCodePOST`: `POST /{apiBasePath}//signinup/code/resend` + ## [3.0.0] - 2024-05-24 ### Changes diff --git a/api_spec.yaml b/api_spec.yaml index 4f3c4a1..79bae82 100644 --- a/api_spec.yaml +++ b/api_spec.yaml @@ -4,7 +4,7 @@ info: description: | These are the APIs exposed by our backend SDK. To be consumed by the frontend only. `` in all the APIs are optional. Its default value is `public` - version: "3.0.0" + version: "3.1.0" title: Frontend Driver Interface contact: email: team@supertokens.io @@ -474,12 +474,18 @@ paths: properties: email: $ref: '#/components/schemas/email' + shouldTryLinkingWithSessionUser: + type: boolean + example: false required: - email - type: object properties: phoneNumber: $ref: '#/components/schemas/phoneNumber' + shouldTryLinkingWithSessionUser: + type: boolean + example: false required: - phoneNumber @@ -540,6 +546,9 @@ paths: $ref: '#/components/schemas/deviceId' preAuthSessionId: $ref: '#/components/schemas/preAuthSessionId' + shouldTryLinkingWithSessionUser: + type: boolean + example: false required: - deviceId - preAuthSessionId @@ -583,6 +592,9 @@ paths: properties: preAuthSessionId: $ref: '#/components/schemas/preAuthSessionId' + shouldTryLinkingWithSessionUser: + type: boolean + example: false linkCode: type: string example: b10lbT_SnDC4flA6Fn7pE5TtG5k5NfigLef4QMBeGA8 @@ -594,6 +606,9 @@ paths: properties: preAuthSessionId: $ref: '#/components/schemas/preAuthSessionId' + shouldTryLinkingWithSessionUser: + type: boolean + example: false deviceId: $ref: '#/components/schemas/deviceId' userInputCode: @@ -938,9 +953,14 @@ paths: application/json: schema: type: object + required: + - formFields properties: formFields: $ref: '#/components/schemas/formFields' + shouldTryLinkingWithSessionUser: + type: boolean + example: false responses: '200': description: Sign in Response @@ -1003,9 +1023,14 @@ paths: application/json: schema: type: object + required: + - formFields properties: formFields: $ref: '#/components/schemas/formFields' + shouldTryLinkingWithSessionUser: + type: boolean + example: false responses: '200': description: Sign up Response @@ -1235,6 +1260,9 @@ paths: pkceCodeVerifier: type: string example: abcd1234 + shouldTryLinkingWithSessionUser: + type: boolean + example: false - type: object required: - thirdPartyId @@ -1246,6 +1274,9 @@ paths: $ref: '#/components/schemas/clientType' oAuthTokens: $ref: '#/components/schemas/oAuthTokens' + shouldTryLinkingWithSessionUser: + type: boolean + example: false responses: '200': description: Signin/up a user