From 0cb020dcba79a0976c17700973f8455b3116898f Mon Sep 17 00:00:00 2001 From: joostdecock Date: Sun, 19 Mar 2023 17:05:19 +0100 Subject: [PATCH] chore(markdown): Updates for recent backend changes --- .../dev/reference/backend/api/account/confirm/en.md | 6 +++--- .../backend/api/account/{login => signin}/en.md | 12 ++++++------ .../dev/reference/backend/api/account/update/en.md | 4 ++-- .../dev/reference/backend/api/authentication/en.md | 2 +- markdown/dev/reference/backend/db/en.md | 4 ++-- 5 files changed, 14 insertions(+), 14 deletions(-) rename markdown/dev/reference/backend/api/account/{login => signin}/en.md (92%) diff --git a/markdown/dev/reference/backend/api/account/confirm/en.md b/markdown/dev/reference/backend/api/account/confirm/en.md index df8616f21c3..e1c39c4d675 100644 --- a/markdown/dev/reference/backend/api/account/confirm/en.md +++ b/markdown/dev/reference/backend/api/account/confirm/en.md @@ -3,7 +3,7 @@ title: Confirm an account --- Confirms a newly created User account. -If confirmation is successful this will also result in a (passwordless) login. +If confirmation is successful this will also result in a (passwordless) sign-in. ## Endpoints @@ -61,7 +61,7 @@ in the response body should indicate the nature of the problem. | `account.imperial` | Boolean| Whether or not the User prefers imperial units | | `account.initial` | String | The E-mail address that the User was created with | | `account.language` | String | The language preferred by the user | -| `account.lastLogin` | String | Date string indicating them moment the User last logged in | +| `account.lastSignIn`| String | Date string indicating them moment the User last signed in | | `account.mfaEnabled`| Boolean| Whether or not the User has MFA enabled | | `account.newsletter`| Boolean| Whether or not the User is subscribed to the FreeSewing newsletter | | `account.patron` | Number | The level of patronage the user provides to FreeSewing | @@ -97,7 +97,7 @@ const confirm = await axios.post( "imperial": false, "initial": "test_54c6856275aaa8a1@freesewing.dev", "language": "en", - "lastLogin": "2022-11-19T18:15:22.668Z", + "lastSignIn": "2022-11-19T18:15:22.668Z", "mfaEnabled": false, "newsletter": false, "patron": 0, diff --git a/markdown/dev/reference/backend/api/account/login/en.md b/markdown/dev/reference/backend/api/account/signin/en.md similarity index 92% rename from markdown/dev/reference/backend/api/account/login/en.md rename to markdown/dev/reference/backend/api/account/signin/en.md index 0d9d6a39c6d..f1ae7c68b1a 100644 --- a/markdown/dev/reference/backend/api/account/login/en.md +++ b/markdown/dev/reference/backend/api/account/signin/en.md @@ -1,16 +1,16 @@ --- -title: Login +title: Sign In --- -Login as a User with username and password, and optional MFA token. +Sign in as a User with username and password, and optional MFA token. ## Endpoints -Password-based login is possible via this endpoint: +Password-based sign-in is possible via this endpoint: | Method | Path | Authentication | | --------: | :--- | :------------- | -| | `/login` | None | +| | `/signin` | None | This endpoint requires no authentication @@ -59,7 +59,7 @@ in the response body should indicate the nature of the problem. | `account.imperial` | Boolean| Whether or not the User prefers imperial units | | `account.initial` | String | The E-mail address that the User was created with | | `account.language` | String | The language preferred by the user | -| `account.lastLogin` | String | Date string indicating them moment the User last logged in | +| `account.lastSignIn`| String | Date string indicating them moment the User last signed in | | `account.mfaEnabled`| Boolean| Whether or not the User has MFA enabled | | `account.newsletter`| Boolean| Whether or not the User is subscribed to the FreeSewing newsletter | | `account.patron` | Number | The level of patronage the user provides to FreeSewing | @@ -99,7 +99,7 @@ const signup = await axios.post( "imperial": false, "initial": "test_54c6856275aaa8a1@freesewing.dev", "language": "en", - "lastLogin": "2022-11-19T18:15:22.668Z", + "lastSignIn": "2022-11-19T18:15:22.668Z", "mfaEnabled": false, "newsletter": false, "patron": 0, diff --git a/markdown/dev/reference/backend/api/account/update/en.md b/markdown/dev/reference/backend/api/account/update/en.md index 388d2db5cbf..50a8b2d1552 100644 --- a/markdown/dev/reference/backend/api/account/update/en.md +++ b/markdown/dev/reference/backend/api/account/update/en.md @@ -66,7 +66,7 @@ in the response body should indicate the nature of the problem. | `account.imperial` | Boolean| Whether or not the User prefers imperial units | | `account.initial` | String | The E-mail address that the User was created with | | `account.language` | String | The language preferred by the user | -| `account.lastLogin` | String | Date string indicating them moment the User last logged in | +| `account.lastSignIn`| String | Date string indicating them moment the User last signed in | | `account.mfaEnabled`| Boolean| Whether or not the User has MFA enabled | | `account.newsletter`| Boolean| Whether or not the User is subscribed to the FreeSewing newsletter | | `account.patron` | Number | The level of patronage the user provides to FreeSewing | @@ -110,7 +110,7 @@ const udpate = await axios.put( "imperial": true, "initial": "test_54c6856275aaa8a1@freesewing.dev", "language": "en", - "lastLogin": "2022-11-19T18:15:22.668Z", + "lastSignIn": "2022-11-19T18:15:22.668Z", "mfaEnabled": false, "newsletter": false, "patron": 0, diff --git a/markdown/dev/reference/backend/api/authentication/en.md b/markdown/dev/reference/backend/api/authentication/en.md index f6b66a89a2a..68982f58265 100644 --- a/markdown/dev/reference/backend/api/authentication/en.md +++ b/markdown/dev/reference/backend/api/authentication/en.md @@ -24,7 +24,7 @@ endpoint: The use of JSON Web Tokens ([jwt](https://jwt.io)) is typically used in a browser context where we want to establish a *session*. -To get a token, you must first authenticate at the [`/login`](/reference/backend/api/user/login) endpoint. +To get a token, you must first authenticate at the [`/signin`](/reference/backend/api/user/signin) endpoint. You will receive a JSON Web Token (jwt) as part of the response. In subsequent API calls, you must then include this token in the diff --git a/markdown/dev/reference/backend/db/en.md b/markdown/dev/reference/backend/db/en.md index e10828f0ff7..a1002a22fd2 100644 --- a/markdown/dev/reference/backend/db/en.md +++ b/markdown/dev/reference/backend/db/en.md @@ -91,7 +91,7 @@ In the tables below, the following symbols are used: | | `imperial` | Boolean | `false` | | 🔐 | `initial` | String(ified JSON) | | | | `language` | String | `en` | -| | `lastLogin` | DateTime | | +| | `lastSignIn`| DateTime | | | ❄️ | `lusername` | String | | | | `newsletter`| Boolean | `false` | | 🧂 | `password` | String(ified JSON) | | @@ -116,7 +116,7 @@ In the tables below, the following symbols are used: "imperial": 0, "initial": "{\"iv\":\"b48d8e4769e359cec69f53629c5ad4ce\",\"ct\":\"57211cdeb0c1d5641aae953b10058e8ad94604df8183a3f5c99517620858674696e1e988ccf8e527f132095c2f303a12\"}", "language": "en", - "lastLogin": 1668447881273, + "lastSignIn": 1668447881273, "lusername": "user-7", "newsletter": 0, "password": "{\"type\":\"v3\",\"hash\":\"bc5b64b1932a5d4a053777011a61a244e07edfe78eaa52beb56d08bf0ec3f8d8946e8749c872db5a03d5720e53b8da1d6df3ee12d96443d107c01dd2392e2848\",\"salt\":\"648d1218a93ded40ad42cc5bed603bcf\"}",