diff --git a/markdown/dev/reference/backend/api/account/confirm/en.md b/markdown/dev/reference/backend/api/account/confirm/en.md index cd29e0fbdc1..d2cd3816a79 100644 --- a/markdown/dev/reference/backend/api/account/confirm/en.md +++ b/markdown/dev/reference/backend/api/account/confirm/en.md @@ -15,9 +15,9 @@ Confirming a new User account is possible via this endpoint: This endpoint requires no authentication -## Request url +## Request URL -The url should contain the confirmation ID that was E-mailed to the E-mail +The URL should contain the confirmation ID that was E-mailed to the E-mail address used for the signup. It replaces the `:id` placeholder in the [endpoint listed above](#endpoints). @@ -56,7 +56,7 @@ in the response body should indicate the nature of the problem. | `account.control` | Number | The control desired by the User | | `account.createdAt` | String | Date string indicating the moment the User was created | | `account.email` | String | The E-mail address currently tied to the User | -| `account.github` | String | The Github username of the User | +| `account.github` | String | The GitHub username of the User | | `account.img` | String | The URL to the image stored with this User | | `account.imperial` | Boolean| Whether or not the User prefers imperial units | | `account.initial` | String | The E-mail address that the User was created with | diff --git a/markdown/dev/reference/backend/api/account/create/en.md b/markdown/dev/reference/backend/api/account/create/en.md index 6016aeaeb2f..c0dc3214fbf 100644 --- a/markdown/dev/reference/backend/api/account/create/en.md +++ b/markdown/dev/reference/backend/api/account/create/en.md @@ -2,7 +2,7 @@ title: Create an account --- -Creates a new User account. The User account will remain inactive +Creates a new User account. The User account will remain inactive until [it is confirmed](/reference/backend/api/account/confirm). ## Endpoints @@ -42,7 +42,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `email` | String | The E-mail address where the confirmation email was sent to | ## Example request diff --git a/markdown/dev/reference/backend/api/account/login/en.md b/markdown/dev/reference/backend/api/account/login/en.md index a5324fb61c9..0d9d6a39c6d 100644 --- a/markdown/dev/reference/backend/api/account/login/en.md +++ b/markdown/dev/reference/backend/api/account/login/en.md @@ -46,7 +46,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `token` | String | A JSON web token (JWT) token to authenticate with | | `account.id` | Number | The ID of the User | | `account.bio` | String | The bio of the User | @@ -54,7 +54,7 @@ in the response body should indicate the nature of the problem. | `account.control` | Number | The control desired by the User | | `account.createdAt` | String | Date string indicating the moment the User was created | | `account.email` | String | The E-mail address currently tied to the User | -| `account.github` | String | The Github username of the User | +| `account.github` | String | The GitHub username of the User | | `account.img` | String | The URL to the image stored with this User | | `account.imperial` | Boolean| Whether or not the User prefers imperial units | | `account.initial` | String | The E-mail address that the User was created with | diff --git a/markdown/dev/reference/backend/api/account/mfa/en.md b/markdown/dev/reference/backend/api/account/mfa/en.md index a1245131625..625334982a5 100644 --- a/markdown/dev/reference/backend/api/account/mfa/en.md +++ b/markdown/dev/reference/backend/api/account/mfa/en.md @@ -47,10 +47,10 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | -------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `mfa.secret` | String | The shared secret for generating one-time password (OTP) tokens | -| `mfa.otpauth` | String | The OTP Auth uri that is encoded in the QR code | -| `mfa.qrcode` | String | SVG to display a QR code with the otpauth uri encoded | +| `mfa.otpauth` | String | The OTP Auth URI that is encoded in the QR code | +| `mfa.qrcode` | String | SVG to display a QR code with the otpauth URI encoded | ##### Styling the SVG @@ -119,7 +119,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | -------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | ### Example request @@ -128,7 +128,7 @@ import { authenticator } from '@otplib/preset-default' const confirm = await axios.post( 'https://backend.freesewing.org/account/mfa/jwt', - { + { mfa: true, secret: mfa.secret, token: authenticator.generate(mfa.secret) @@ -182,7 +182,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | -------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | ### Example request @@ -191,7 +191,7 @@ import { authenticator } from '@otplib/preset-default' const confirm = await axios.post( 'https://backend.freesewing.org/account/mfa/jwt', - { + { mfa: false, password: "I like big bewbs and I just can't lie", token: authenticator.generate(mfa.secret) @@ -211,4 +211,3 @@ const confirm = await axios.post( "result": "success", } ``` - diff --git a/markdown/dev/reference/backend/api/account/update/en.md b/markdown/dev/reference/backend/api/account/update/en.md index de5afd79151..388d2db5cbf 100644 --- a/markdown/dev/reference/backend/api/account/update/en.md +++ b/markdown/dev/reference/backend/api/account/update/en.md @@ -25,7 +25,7 @@ Updating an existing User account is possible via these endpoints: | `bio` | `string` | The User's bio | | `consent` | `string` | A number that indicates [the consent given by the user](/reference/backend/api/account#the-consent-field-is-about-data-protection) | | `control` | `string` | A number that indicates [the level of control the user prefers](/reference/backend/api/account#the-control-field-is-about-keeping-it-simple) | -| `github` | `string` | The User's username on Github | +| `github` | `string` | The User's username on GitHub | | `imperial` | `boolean`| Whether or not the User prefers imperial units | | `newsletter`| `boolean`| Whether this Person prefers imperial measurements (`true`) or not (`false`) | | `img` | `string` | An image [data-uri][duri] to store with this Person | @@ -54,14 +54,14 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `account.id` | Number | The ID of the User | | `account.bio` | String | The bio of the User | | `account.consent` | Number | The consent given by the User | | `account.control` | Number | The control desired by the User | | `account.createdAt` | String | Date string indicating the moment the User was created | | `account.email` | String | The E-mail address currently tied to the User | -| `account.github` | String | The Github username of the User | +| `account.github` | String | The GitHub username of the User | | `account.img` | String | The URL to the image stored with this User | | `account.imperial` | Boolean| Whether or not the User prefers imperial units | | `account.initial` | String | The E-mail address that the User was created with | diff --git a/markdown/dev/reference/backend/api/authentication/en.md b/markdown/dev/reference/backend/api/authentication/en.md index e8c0f9a0a66..f6b66a89a2a 100644 --- a/markdown/dev/reference/backend/api/authentication/en.md +++ b/markdown/dev/reference/backend/api/authentication/en.md @@ -2,7 +2,7 @@ title: Authentication --- -The FreeSewing backend API requires authentication for all but a handfull of +The FreeSewing backend API requires authentication for all but a handful of endpoints. The API supports two different types of authentication: @@ -48,17 +48,17 @@ basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) In basic authentication, the password is sent -unencrypted. To guard against this, this API should only be served over a -connection that is encrypted with TLS. (a url starting with `https://`). +unencrypted. To guard against this, this API should only be served over a +connection that is encrypted with TLS. (a URL starting with `https://`). Sending a username and password with a request like this is supported pretty much everywhere. In addition, there is no need to establish a session -first, so this make the entire transation stateless. +first, so this make the entire transaction stateless. Below is an example using curl: ```sh -curl -u api-key-here:api-secret-here \ +curl -u api-key-here:api-secret-here \ https://backend.freesewing.org/account/key ``` diff --git a/markdown/dev/reference/backend/api/patterns/clone/en.md b/markdown/dev/reference/backend/api/patterns/clone/en.md index 04ff4110ffe..ae8e01830bf 100644 --- a/markdown/dev/reference/backend/api/patterns/clone/en.md +++ b/markdown/dev/reference/backend/api/patterns/clone/en.md @@ -28,9 +28,9 @@ Creating a new Person is possible via these endpoints: | | `/patterns/:id/clone/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) | | | `/patterns/:id/clone/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) | -## Request url +## Request URL -The url should contain the ID of the Pattern you wish to remove. +The URL should contain the ID of the Pattern you wish to remove. It replaces the `:id` placeholder in the [endpoints listed above](#endpoints). ## Response status codes @@ -55,7 +55,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `pattern.id` | Number | The ID of the Pattern | | `pattern.createdAt` | String | Date string indicating the moment the pattern was created | | `pattern.data` | Object | Any additional data that was stored with Pattern data | @@ -107,4 +107,3 @@ const clone = axios.post( } } ``` - diff --git a/markdown/dev/reference/backend/api/patterns/create/en.md b/markdown/dev/reference/backend/api/patterns/create/en.md index 34e5d2e39bc..4fd6686d354 100644 --- a/markdown/dev/reference/backend/api/patterns/create/en.md +++ b/markdown/dev/reference/backend/api/patterns/create/en.md @@ -52,7 +52,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `pattern.id` | Number | The ID of the Pattern | | `pattern.createdAt` | String | Date string indicating the moment the pattern was created | | `pattern.data` | Object | Any additional data that was stored with Pattern data | diff --git a/markdown/dev/reference/backend/api/patterns/delete/en.md b/markdown/dev/reference/backend/api/patterns/delete/en.md index 30058f0e4d0..7648469790b 100644 --- a/markdown/dev/reference/backend/api/patterns/delete/en.md +++ b/markdown/dev/reference/backend/api/patterns/delete/en.md @@ -18,9 +18,9 @@ Deleting a Pattern is possible via these endpoints: | | `/patterns/:id/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) | | | `/patterns/:id/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) | -## Request url +## Request URL -The url should contain the ID of the Pattern you wish to remove. +The URL should contain the ID of the Pattern you wish to remove. It replaces the `:id` placeholder in the [endpoints listed above](#endpoints). ## Response status codes @@ -56,4 +56,3 @@ await axios.delete( These endpoints return status code (no content) on success, with no response body. - diff --git a/markdown/dev/reference/backend/api/patterns/en.md b/markdown/dev/reference/backend/api/patterns/en.md index 1f3060b74be..e63b1e73280 100644 --- a/markdown/dev/reference/backend/api/patterns/en.md +++ b/markdown/dev/reference/backend/api/patterns/en.md @@ -24,11 +24,10 @@ Keep in mind that: - The `notes` property is intended to be used by the user to add notes about their pattern. It will only accept data of type `string`. - The `data` property is intended to allow frontend developers to store - additional data about the pattern. It wil only accept data of type `object`. + additional data about the pattern. It will only accept data of type `object`. ### The `settings` property should hold the pattern settings The `settings` property should hold [a settings object](/reference/settings) that can be passed to [the Pattern constructor](/reference/api/pattern#creating-a-pattern). - diff --git a/markdown/dev/reference/backend/api/patterns/read/en.md b/markdown/dev/reference/backend/api/patterns/read/en.md index 72647f1f3f8..73b5f2e12df 100644 --- a/markdown/dev/reference/backend/api/patterns/read/en.md +++ b/markdown/dev/reference/backend/api/patterns/read/en.md @@ -2,7 +2,7 @@ title: Read a Pattern --- -Reads an existing Pattern. +Reads an existing Pattern. ## Access control @@ -28,9 +28,9 @@ Reading a Pattern is possible via these endpoints: | | `/patterns/:id/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) | | | `/patterns/:id/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) | -## Request url +## Request URL -The url should contain the ID of the Pattern you wish to read. +The URL should contain the ID of the Pattern you wish to read. It replaces the `:id` placeholder in the [endpoints listed above](#endpoints). ## Response status codes @@ -56,7 +56,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `pattern.id` | Number | The ID of the Pattern | | `pattern.createdAt` | String | Date string indicating the moment the pattern was created | | `pattern.data` | Object | Any additional data that was stored with Pattern data | diff --git a/markdown/dev/reference/backend/api/patterns/update/en.md b/markdown/dev/reference/backend/api/patterns/update/en.md index 6eb1ddd301b..0345d1c64a7 100644 --- a/markdown/dev/reference/backend/api/patterns/update/en.md +++ b/markdown/dev/reference/backend/api/patterns/update/en.md @@ -18,9 +18,9 @@ Updating an existing Pattern is possible via these endpoints: | | `/patterns/:id/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) | | | `/patterns/:id/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) | -## Request url +## Request URL -The url should contain the ID of the Pattern you wish to remove. +The URL should contain the ID of the Pattern you wish to remove. It replaces the `:id` placeholder in the [endpoints listed above](#endpoints). ## Request body @@ -57,7 +57,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `pattern.id` | Number | The ID of the Pattern | | `pattern.createdAt` | String | Date string indicating the moment the pattern was created | | `pattern.data` | Object | Any additional data that was stored with Pattern data | diff --git a/markdown/dev/reference/backend/api/people/clone/en.md b/markdown/dev/reference/backend/api/people/clone/en.md index 0e4b5f6ef98..69d70af5941 100644 --- a/markdown/dev/reference/backend/api/people/clone/en.md +++ b/markdown/dev/reference/backend/api/people/clone/en.md @@ -28,9 +28,9 @@ Creating a new Person is possible via these endpoints: | | `/people/:id/clone/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) | | | `/people/:id/clone/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) | -## Request url +## Request URL -The url should contain the ID of the Person you wish to remove. +The URL should contain the ID of the Person you wish to remove. It replaces the `:id` placeholder in the [endpoints listed above](#endpoints). ## Response status codes @@ -55,7 +55,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `person.id` | Number | The ID of the Person | | `person.createdAt` | String | Date string indicating the moment the Person was created | | `person.img` | String | The URL to the image stored with this Person | @@ -101,4 +101,3 @@ const clone = axios.post( } } ``` - diff --git a/markdown/dev/reference/backend/api/people/create/en.md b/markdown/dev/reference/backend/api/people/create/en.md index 421559821ce..e605400fe38 100644 --- a/markdown/dev/reference/backend/api/people/create/en.md +++ b/markdown/dev/reference/backend/api/people/create/en.md @@ -2,7 +2,7 @@ title: Create a Person --- -Creates a new Person. +Creates a new Person. ## Access control @@ -50,7 +50,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `person.id` | Number | The ID of the Person | | `person.createdAt` | String | Date string indicating the moment the Person was created | | `person.img` | String | The URL to the image stored with this Person | diff --git a/markdown/dev/reference/backend/api/people/delete/en.md b/markdown/dev/reference/backend/api/people/delete/en.md index 7e4a98944bc..eda843085f0 100644 --- a/markdown/dev/reference/backend/api/people/delete/en.md +++ b/markdown/dev/reference/backend/api/people/delete/en.md @@ -18,9 +18,9 @@ Deleting a Person is possible via these endpoints: | | `/people/:id/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) | | | `/people/:id/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) | -## Request url +## Request URL -The url should contain the ID of the Person you wish to remove. +The URL should contain the ID of the Person you wish to remove. It replaces the `:id` placeholder in the [endpoints listed above](#endpoints). ## Response status codes @@ -56,4 +56,3 @@ await axios.delete( These endpoints return status code (no content) on success, with no response body. - diff --git a/markdown/dev/reference/backend/api/people/en.md b/markdown/dev/reference/backend/api/people/en.md index f4a6759cbf4..21eacaa9774 100644 --- a/markdown/dev/reference/backend/api/people/en.md +++ b/markdown/dev/reference/backend/api/people/en.md @@ -11,7 +11,7 @@ for. ## Notes -### The `imperial` property is a boolean +### The `imperial` property is a Boolean - If the `imperial` property is `false`, the person wants metric units. - If the `imperial` property is `true`, the person wants imperial units. @@ -25,12 +25,12 @@ object](/reference/settings/measurements). The backend will only accept known measurements listed in the configuration file. -##### Why we use measies instead of measurements +##### Why we use measies instead of measurements First of all, _measies_ is a cute and adorable alternative for _measurements_ coined by Karen. She deserves all the credit. But also, I am slightly dyslexic and for some reason, I often drop the middle -_e_ when typing measurments (sic). +_e_ when typing measurements' (sic). Those typos lead to bugs and I find it much easier to write _measies_. So because fewer bugs, plus did I mention it's cute? @@ -42,4 +42,3 @@ So because fewer bugs, plus did I mention it's cute? The `settings` property should hold [a settings object](/reference/settings) that can be passed to [the Pattern constructor](/reference/api/pattern#creating-a-pattern). - diff --git a/markdown/dev/reference/backend/api/people/read/en.md b/markdown/dev/reference/backend/api/people/read/en.md index e498c7788a0..397e786da78 100644 --- a/markdown/dev/reference/backend/api/people/read/en.md +++ b/markdown/dev/reference/backend/api/people/read/en.md @@ -2,7 +2,7 @@ title: Read a Person --- -Reads an existing Person. +Reads an existing Person. ## Access control @@ -56,7 +56,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `person.id` | Number | The ID of the Person | | `person.createdAt` | String | Date string indicating the moment the Person was created | | `person.img` | String | The URL to the image stored with this Person | diff --git a/markdown/dev/reference/backend/api/people/update/en.md b/markdown/dev/reference/backend/api/people/update/en.md index 95c42e72320..9b14d54b505 100644 --- a/markdown/dev/reference/backend/api/people/update/en.md +++ b/markdown/dev/reference/backend/api/people/update/en.md @@ -18,9 +18,9 @@ Updating an existing Person is possible via these endpoints: | | `/people/:id/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) | | | `/people/:id/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) | -## Request url +## Request URL -The url should contain the ID of the Person you wish to remove. +The URL should contain the ID of the Person you wish to remove. It replaces the `:id` placeholder in the [endpoints listed above](#endpoints). ## Request body @@ -56,7 +56,7 @@ in the response body should indicate the nature of the problem. | Value | Type | Description | | ------------------- | -------- | ----------- | | `result` | String | Either `success` or `error` | -| `error` | String | Will give info on the nature of the error. Only set if an error occured. | +| `error` | String | Will give info on the nature of the error. Only set if an error occurred. | | `person.id` | Number | The ID of the Person | | `person.createdAt` | String | Date string indicating the moment the Person was created | | `person.img` | String | The URL to the image stored with this Person |