feat: Flat import of markdown repo
This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
This commit is contained in:
Joost De Cock
parent
1671a896b5
commit
b34a2ee2ed
6132 changed files with 244167 additions and 0 deletions
107
markdown/dev/reference/backend/account/de.md
Normal file
107
markdown/dev/reference/backend/account/de.md
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
---
|
||||
title: Account
|
||||
---
|
||||
|
||||
## Load account
|
||||
```
|
||||
GET /account
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Update account
|
||||
```
|
||||
PUT /account
|
||||
{
|
||||
'bio': 'The new bio',
|
||||
'avatar': 'data:image/png;base64,iVBORw0KGg...'
|
||||
'password': 'new password',
|
||||
'username': 'new username',
|
||||
'email': 'new.email@domain.com',
|
||||
'social': {
|
||||
'github': 'githubUsername',
|
||||
'twitter': 'twitterUsername',
|
||||
'isntagram': 'instagramUsername'
|
||||
},
|
||||
'settings': {
|
||||
'language': 'fr',
|
||||
'units': 'imperial',
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': false,
|
||||
'openData': false
|
||||
},
|
||||
```
|
||||
On success: The (updated) account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This will only update what you pass it
|
||||
- This will only handle one top-level attribute per call
|
||||
- A change of email won't take effect immediately but instead trigger an email for confirmation. The email will be sent to the new email address, with the current email address in CC.
|
||||
|
||||
## Remove account
|
||||
```
|
||||
DELETE /account
|
||||
```
|
||||
On success:
|
||||
```
|
||||
204
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the account and all user's data. Will also trigger a goodbye email.
|
||||
|
||||
## Confirm email change
|
||||
```
|
||||
POST /account/change/email
|
||||
{
|
||||
'id': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Changing your email address requires confirmation, and this endpoint is for that.
|
||||
|
||||
## Export account
|
||||
```
|
||||
GET /account/export
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'export': 'https://static.freesewing.org/tmp/msypflkyyw/export.zip'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will export the user data and publish it for download.
|
||||
|
||||
## Restrict account
|
||||
```
|
||||
GET /account/restrict
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will lock the user account, thereby restricting processing of their data.
|
||||
|
||||
110
markdown/dev/reference/backend/account/en.md
Normal file
110
markdown/dev/reference/backend/account/en.md
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
---
|
||||
title: Account
|
||||
---
|
||||
|
||||
## Load account
|
||||
```
|
||||
GET /account
|
||||
```
|
||||
On success: The account data
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Update account
|
||||
```
|
||||
PUT /account
|
||||
{
|
||||
'bio': 'The new bio',
|
||||
'avatar': 'data:image/png;base64,iVBORw0KGg...'
|
||||
'password': 'new password',
|
||||
'username': 'new username',
|
||||
'email': 'new.email@domain.com',
|
||||
'social': {
|
||||
'github': 'githubUsername',
|
||||
'twitter': 'twitterUsername',
|
||||
'isntagram': 'instagramUsername'
|
||||
},
|
||||
'settings': {
|
||||
'language': 'fr',
|
||||
'units': 'imperial',
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': false,
|
||||
'openData': false
|
||||
},
|
||||
```
|
||||
On success: The (updated) account data
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This will only update what you pass it
|
||||
- This will only handle one top-level attribute per call
|
||||
- A change of email won't take effect immediately but instead trigger an email for confirmation. The email will be sent to the new email address, with the current email address in CC.
|
||||
|
||||
## Remove account
|
||||
```
|
||||
DELETE /account
|
||||
```
|
||||
On success:
|
||||
```
|
||||
204
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the account and all user's data. Will also trigger a goodbye email.
|
||||
|
||||
## Confirm email change
|
||||
```
|
||||
POST /account/change/email
|
||||
{
|
||||
'id': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Changing your email address requires confirmation, and this endpoint is for that.
|
||||
|
||||
## Export account
|
||||
```
|
||||
GET /account/export
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'export': 'https://static.freesewing.org/tmp/msypflkyyw/export.zip'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will export the user data and publish it for download.
|
||||
|
||||
## Restrict account
|
||||
```
|
||||
GET /account/restrict
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will lock the user account, thereby restricting processing of their data.
|
||||
|
||||
107
markdown/dev/reference/backend/account/es.md
Normal file
107
markdown/dev/reference/backend/account/es.md
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
---
|
||||
title: Account
|
||||
---
|
||||
|
||||
## Load account
|
||||
```
|
||||
GET /account
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Update account
|
||||
```
|
||||
PUT /account
|
||||
{
|
||||
'bio': 'The new bio',
|
||||
'avatar': 'data:image/png;base64,iVBORw0KGg...'
|
||||
'password': 'new password',
|
||||
'username': 'new username',
|
||||
'email': 'new.email@domain.com',
|
||||
'social': {
|
||||
'github': 'githubUsername',
|
||||
'twitter': 'twitterUsername',
|
||||
'isntagram': 'instagramUsername'
|
||||
},
|
||||
'settings': {
|
||||
'language': 'fr',
|
||||
'units': 'imperial',
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': false,
|
||||
'openData': false
|
||||
},
|
||||
```
|
||||
On success: The (updated) account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This will only update what you pass it
|
||||
- This will only handle one top-level attribute per call
|
||||
- A change of email won't take effect immediately but instead trigger an email for confirmation. The email will be sent to the new email address, with the current email address in CC.
|
||||
|
||||
## Remove account
|
||||
```
|
||||
DELETE /account
|
||||
```
|
||||
On success:
|
||||
```
|
||||
204
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the account and all user's data. Will also trigger a goodbye email.
|
||||
|
||||
## Confirm email change
|
||||
```
|
||||
POST /account/change/email
|
||||
{
|
||||
'id': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Changing your email address requires confirmation, and this endpoint is for that.
|
||||
|
||||
## Export account
|
||||
```
|
||||
GET /account/export
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'export': 'https://static.freesewing.org/tmp/msypflkyyw/export.zip'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will export the user data and publish it for download.
|
||||
|
||||
## Restrict account
|
||||
```
|
||||
GET /account/restrict
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will lock the user account, thereby restricting processing of their data.
|
||||
|
||||
107
markdown/dev/reference/backend/account/fr.md
Normal file
107
markdown/dev/reference/backend/account/fr.md
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
---
|
||||
title: Account
|
||||
---
|
||||
|
||||
## Load account
|
||||
```
|
||||
GET /account
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Update account
|
||||
```
|
||||
PUT /account
|
||||
{
|
||||
'bio': 'The new bio',
|
||||
'avatar': 'data:image/png;base64,iVBORw0KGg...'
|
||||
'password': 'new password',
|
||||
'username': 'new username',
|
||||
'email': 'new.email@domain.com',
|
||||
'social': {
|
||||
'github': 'githubUsername',
|
||||
'twitter': 'twitterUsername',
|
||||
'isntagram': 'instagramUsername'
|
||||
},
|
||||
'settings': {
|
||||
'language': 'fr',
|
||||
'units': 'imperial',
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': false,
|
||||
'openData': false
|
||||
},
|
||||
```
|
||||
On success: The (updated) account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This will only update what you pass it
|
||||
- This will only handle one top-level attribute per call
|
||||
- A change of email won't take effect immediately but instead trigger an email for confirmation. The email will be sent to the new email address, with the current email address in CC.
|
||||
|
||||
## Remove account
|
||||
```
|
||||
DELETE /account
|
||||
```
|
||||
On success:
|
||||
```
|
||||
204
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the account and all user's data. Will also trigger a goodbye email.
|
||||
|
||||
## Confirm email change
|
||||
```
|
||||
POST /account/change/email
|
||||
{
|
||||
'id': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Changing your email address requires confirmation, and this endpoint is for that.
|
||||
|
||||
## Export account
|
||||
```
|
||||
GET /account/export
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'export': 'https://static.freesewing.org/tmp/msypflkyyw/export.zip'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will export the user data and publish it for download.
|
||||
|
||||
## Restrict account
|
||||
```
|
||||
GET /account/restrict
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will lock the user account, thereby restricting processing of their data.
|
||||
|
||||
107
markdown/dev/reference/backend/account/nl.md
Normal file
107
markdown/dev/reference/backend/account/nl.md
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
---
|
||||
title: Account
|
||||
---
|
||||
|
||||
## Load account
|
||||
```
|
||||
GET /account
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Update account
|
||||
```
|
||||
PUT /account
|
||||
{
|
||||
'bio': 'The new bio',
|
||||
'avatar': 'data:image/png;base64,iVBORw0KGg...'
|
||||
'password': 'new password',
|
||||
'username': 'new username',
|
||||
'email': 'new.email@domain.com',
|
||||
'social': {
|
||||
'github': 'githubUsername',
|
||||
'twitter': 'twitterUsername',
|
||||
'isntagram': 'instagramUsername'
|
||||
},
|
||||
'settings': {
|
||||
'language': 'fr',
|
||||
'units': 'imperial',
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': false,
|
||||
'openData': false
|
||||
},
|
||||
```
|
||||
On success: The (updated) account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This will only update what you pass it
|
||||
- This will only handle one top-level attribute per call
|
||||
- A change of email won't take effect immediately but instead trigger an email for confirmation. The email will be sent to the new email address, with the current email address in CC.
|
||||
|
||||
## Remove account
|
||||
```
|
||||
DELETE /account
|
||||
```
|
||||
On success:
|
||||
```
|
||||
204
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the account and all user's data. Will also trigger a goodbye email.
|
||||
|
||||
## Confirm email change
|
||||
```
|
||||
POST /account/change/email
|
||||
{
|
||||
'id': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Changing your email address requires confirmation, and this endpoint is for that.
|
||||
|
||||
## Export account
|
||||
```
|
||||
GET /account/export
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'export': 'https://static.freesewing.org/tmp/msypflkyyw/export.zip'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will export the user data and publish it for download.
|
||||
|
||||
## Restrict account
|
||||
```
|
||||
GET /account/restrict
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Will lock the user account, thereby restricting processing of their data.
|
||||
|
||||
48
markdown/dev/reference/backend/de.md
Normal file
48
markdown/dev/reference/backend/de.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: Backend API
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
See also: [The backend documentation](/reference/repos/backend/)
|
||||
|
||||
</Note>
|
||||
|
||||
## API Cheat sheet
|
||||
With authentication:
|
||||
|
||||
| 🔐 | Method | Endpoint | Description |
|
||||
| - | -------- | ----------------------- | ------------------------------------------------------------------------ |
|
||||
| 🔐 | `POST` | `/models` | [Creates model](/reference/backend/models/#create-model) |
|
||||
| 🔐 | `GET` | `/models/:handle` | [Read model](/reference/backend/models/#read-model) |
|
||||
| 🔐 | `PUT` | `/models/:handle` | [Update model](/reference/backend/models/#update-model) |
|
||||
| 🔐 | `DELETE` | `/models/:handle` | [Remove model](/reference/backend/models/#remove-model) |
|
||||
| 🔐 | `POST` | `/recipes` | [Create recipe](/reference/backend/recipes/#create-recipe) |
|
||||
| 🔐 | `GET` | `/recipes/:handle` | [Read recipe](/reference/backend/recipes/#read-recipe) |
|
||||
| 🔐 | `PUT` | `/recipes/:handle` | [Updates recipe](/reference/backend/recipes/#update-recipe) |
|
||||
| 🔐 | `DELETE` | `/recipes/:handle` | [Remove recipe](/reference/backend/recipes/#remove-recipe) |
|
||||
| 🔐 | `GET` | `/account` | [Load account](/reference/backend/account/#load-account) |
|
||||
| 🔐 | `PUT` | `/account` | [Update account](/reference/backend/account/#update-account) |
|
||||
| 🔐 | `DELETE` | `/account` | [Remove account](/reference/backend/account/#remove-account) |
|
||||
| 🔐 | `POST` | `/account/change/email` | [Confirm email change](/reference/backend/account/#confirm-email-change) |
|
||||
| 🔐 | `GET` | `/account/export` | [Export account](/reference/backend/account/#export-account) |
|
||||
| 🔐 | `GET` | `/account/restrict` | [Restric account](/reference/backend/account/#restrict-account) |
|
||||
| 🔐 | `GET` | `/users/:username` | [Read user profile](/reference/backend/users/#read-user-profile) |
|
||||
| 🔐 | `POST` | `/available/username` | [Is username available](/reference/backend/users/#is-username-available) |
|
||||
|
||||
Without authentication:
|
||||
|
||||
| 🔓 | Method | Endpoint | Description |
|
||||
| - | ------ | -------------------------------- | ---------------------------------------------------------------------- |
|
||||
| 🔓 | `POST` | `/signup` | [Request account](/reference/backend/signup/#request-account) |
|
||||
| 🔓 | `POST` | `/account` | [Create account](/reference/backend/signup/#create-account) |
|
||||
| 🔓 | `POST` | `/login` | [Log in](/reference/backend/login/#log-in) |
|
||||
| 🔓 | `POST` | `/reset/password` | [Recover password](/reference/backend/login/#recover-password) |
|
||||
| 🔓 | `POST` | `/confirm/login` | [Passwordless login](/reference/backend/login/#passwordless-login) |
|
||||
| 🔓 | `POST` | `/oauth/init` | [Oauth initialisation](/reference/backend/oauth/#oauth-initialisation) |
|
||||
| 🔓 | `GET` | `/oauth/callback/from/:provider` | [Oauth callback](/reference/backend/oauth/#oauth-callback) |
|
||||
| 🔓 | `POST` | `/oauth/login` | [Oauth login](/reference/backend/oauth/#oauth-login) |
|
||||
| 🔓 | `GET` | `/patrons` | [Patron list](/reference/backend/users/#patron-list) |
|
||||
|
||||
|
||||
<ReadMore root='reference/backend' box />
|
||||
52
markdown/dev/reference/backend/en.md
Normal file
52
markdown/dev/reference/backend/en.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
title: Backend API
|
||||
for: developers
|
||||
about: Documentation for our backend REST API
|
||||
---
|
||||
|
||||
<Fixme>This documentation is outdated</Fixme>
|
||||
|
||||
<Note>
|
||||
|
||||
See also: [The backend documentation](/reference/repos/backend/)
|
||||
|
||||
</Note>
|
||||
|
||||
## API Cheat sheet
|
||||
With authentication:
|
||||
|
||||
|🔐| Method | Endpoint | Description |
|
||||
|--- |--------|----------|-------------|
|
||||
|🔐|`POST`|`/models`| [Creates model](/reference/backend/models/#create-model) |
|
||||
|🔐|`GET`|`/models/:handle`| [Read model](/reference/backend/models/#read-model) |
|
||||
|🔐|`PUT`|`/models/:handle`| [Update model](/reference/backend/models/#update-model) |
|
||||
|🔐|`DELETE`|`/models/:handle`| [Remove model](/reference/backend/models/#remove-model) |
|
||||
|🔐|`POST`|`/recipes`| [Create recipe](/reference/backend/recipes/#create-recipe) |
|
||||
|🔐|`GET`|`/recipes/:handle`| [Read recipe](/reference/backend/recipes/#read-recipe) |
|
||||
|🔐|`PUT`|`/recipes/:handle`| [Updates recipe](/reference/backend/recipes/#update-recipe) |
|
||||
|🔐|`DELETE`|`/recipes/:handle`| [Remove recipe](/reference/backend/recipes/#remove-recipe) |
|
||||
|🔐|`GET`|`/account`| [Load account](/reference/backend/account/#load-account) |
|
||||
|🔐|`PUT`|`/account`| [Update account](/reference/backend/account/#update-account) |
|
||||
|🔐|`DELETE`|`/account`| [Remove account](/reference/backend/account/#remove-account) |
|
||||
|🔐|`POST`|`/account/change/email`| [Confirm email change](/reference/backend/account/#confirm-email-change) |
|
||||
|🔐|`GET`|`/account/export`| [Export account](/reference/backend/account/#export-account) |
|
||||
|🔐|`GET`|`/account/restrict`| [Restric account](/reference/backend/account/#restrict-account) |
|
||||
|🔐|`GET`|`/users/:username`| [Read user profile](/reference/backend/users/#read-user-profile)
|
||||
|🔐|`POST`|`/available/username`| [Is username available](/reference/backend/users/#is-username-available) |
|
||||
|
||||
Without authentication:
|
||||
|
||||
|🔓| Method | Endpoint | Description |
|
||||
|--- |--------|----------|-------------|
|
||||
|🔓|`POST`|`/signup`| [Request account](/reference/backend/signup/#request-account) |
|
||||
|🔓|`POST`|`/account`| [Create account](/reference/backend/signup/#create-account) |
|
||||
|🔓|`POST`|`/login`| [Log in](/reference/backend/login/#log-in) |
|
||||
|🔓|`POST`|`/reset/password`| [Recover password](/reference/backend/login/#recover-password) |
|
||||
|🔓|`POST`|`/confirm/login`| [Passwordless login](/reference/backend/login/#passwordless-login) |
|
||||
|🔓|`POST`|`/oauth/init`| [Oauth initialisation](/reference/backend/oauth/#oauth-initialisation) |
|
||||
|🔓|`GET`|`/oauth/callback/from/:provider`| [Oauth callback](/reference/backend/oauth/#oauth-callback) |
|
||||
|🔓|`POST`|`/oauth/login`| [Oauth login](/reference/backend/oauth/#oauth-login) |
|
||||
|🔓|`GET`|`/patrons`| [Patron list](/reference/backend/users/#patron-list) |
|
||||
|
||||
|
||||
<ReadMore root='reference/backend' box />
|
||||
48
markdown/dev/reference/backend/es.md
Normal file
48
markdown/dev/reference/backend/es.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: Backend API
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
See also: [The backend documentation](/reference/repos/backend/)
|
||||
|
||||
</Note>
|
||||
|
||||
## API Cheat sheet
|
||||
With authentication:
|
||||
|
||||
| 🔐 | Method | Endpoint | Description |
|
||||
| - | -------- | ----------------------- | ------------------------------------------------------------------------ |
|
||||
| 🔐 | `POST` | `/models` | [Creates model](/reference/backend/models/#create-model) |
|
||||
| 🔐 | `GET` | `/models/:handle` | [Read model](/reference/backend/models/#read-model) |
|
||||
| 🔐 | `PUT` | `/models/:handle` | [Update model](/reference/backend/models/#update-model) |
|
||||
| 🔐 | `DELETE` | `/models/:handle` | [Remove model](/reference/backend/models/#remove-model) |
|
||||
| 🔐 | `POST` | `/recipes` | [Create recipe](/reference/backend/recipes/#create-recipe) |
|
||||
| 🔐 | `GET` | `/recipes/:handle` | [Read recipe](/reference/backend/recipes/#read-recipe) |
|
||||
| 🔐 | `PUT` | `/recipes/:handle` | [Updates recipe](/reference/backend/recipes/#update-recipe) |
|
||||
| 🔐 | `DELETE` | `/recipes/:handle` | [Remove recipe](/reference/backend/recipes/#remove-recipe) |
|
||||
| 🔐 | `GET` | `/account` | [Load account](/reference/backend/account/#load-account) |
|
||||
| 🔐 | `PUT` | `/account` | [Update account](/reference/backend/account/#update-account) |
|
||||
| 🔐 | `DELETE` | `/account` | [Remove account](/reference/backend/account/#remove-account) |
|
||||
| 🔐 | `POST` | `/account/change/email` | [Confirm email change](/reference/backend/account/#confirm-email-change) |
|
||||
| 🔐 | `GET` | `/account/export` | [Export account](/reference/backend/account/#export-account) |
|
||||
| 🔐 | `GET` | `/account/restrict` | [Restric account](/reference/backend/account/#restrict-account) |
|
||||
| 🔐 | `GET` | `/users/:username` | [Read user profile](/reference/backend/users/#read-user-profile) |
|
||||
| 🔐 | `POST` | `/available/username` | [Is username available](/reference/backend/users/#is-username-available) |
|
||||
|
||||
Without authentication:
|
||||
|
||||
| 🔓 | Method | Endpoint | Description |
|
||||
| - | ------ | -------------------------------- | ---------------------------------------------------------------------- |
|
||||
| 🔓 | `POST` | `/signup` | [Request account](/reference/backend/signup/#request-account) |
|
||||
| 🔓 | `POST` | `/account` | [Create account](/reference/backend/signup/#create-account) |
|
||||
| 🔓 | `POST` | `/login` | [Log in](/reference/backend/login/#log-in) |
|
||||
| 🔓 | `POST` | `/reset/password` | [Recover password](/reference/backend/login/#recover-password) |
|
||||
| 🔓 | `POST` | `/confirm/login` | [Passwordless login](/reference/backend/login/#passwordless-login) |
|
||||
| 🔓 | `POST` | `/oauth/init` | [Oauth initialisation](/reference/backend/oauth/#oauth-initialisation) |
|
||||
| 🔓 | `GET` | `/oauth/callback/from/:provider` | [Oauth callback](/reference/backend/oauth/#oauth-callback) |
|
||||
| 🔓 | `POST` | `/oauth/login` | [Oauth login](/reference/backend/oauth/#oauth-login) |
|
||||
| 🔓 | `GET` | `/patrons` | [Patron list](/reference/backend/users/#patron-list) |
|
||||
|
||||
|
||||
<ReadMore root='reference/backend' box />
|
||||
48
markdown/dev/reference/backend/fr.md
Normal file
48
markdown/dev/reference/backend/fr.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: Backend API
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
See also: [The backend documentation](/reference/repos/backend/)
|
||||
|
||||
</Note>
|
||||
|
||||
## API Cheat sheet
|
||||
With authentication:
|
||||
|
||||
| 🔐 | Method | Endpoint | Description |
|
||||
| - | -------- | ----------------------- | ------------------------------------------------------------------------ |
|
||||
| 🔐 | `POST` | `/models` | [Creates model](/reference/backend/models/#create-model) |
|
||||
| 🔐 | `GET` | `/models/:handle` | [Read model](/reference/backend/models/#read-model) |
|
||||
| 🔐 | `PUT` | `/models/:handle` | [Update model](/reference/backend/models/#update-model) |
|
||||
| 🔐 | `DELETE` | `/models/:handle` | [Remove model](/reference/backend/models/#remove-model) |
|
||||
| 🔐 | `POST` | `/recipes` | [Create recipe](/reference/backend/recipes/#create-recipe) |
|
||||
| 🔐 | `GET` | `/recipes/:handle` | [Read recipe](/reference/backend/recipes/#read-recipe) |
|
||||
| 🔐 | `PUT` | `/recipes/:handle` | [Updates recipe](/reference/backend/recipes/#update-recipe) |
|
||||
| 🔐 | `DELETE` | `/recipes/:handle` | [Remove recipe](/reference/backend/recipes/#remove-recipe) |
|
||||
| 🔐 | `GET` | `/account` | [Load account](/reference/backend/account/#load-account) |
|
||||
| 🔐 | `PUT` | `/account` | [Update account](/reference/backend/account/#update-account) |
|
||||
| 🔐 | `DELETE` | `/account` | [Remove account](/reference/backend/account/#remove-account) |
|
||||
| 🔐 | `POST` | `/account/change/email` | [Confirm email change](/reference/backend/account/#confirm-email-change) |
|
||||
| 🔐 | `GET` | `/account/export` | [Export account](/reference/backend/account/#export-account) |
|
||||
| 🔐 | `GET` | `/account/restrict` | [Restric account](/reference/backend/account/#restrict-account) |
|
||||
| 🔐 | `GET` | `/users/:username` | [Read user profile](/reference/backend/users/#read-user-profile) |
|
||||
| 🔐 | `POST` | `/available/username` | [Is username available](/reference/backend/users/#is-username-available) |
|
||||
|
||||
Without authentication:
|
||||
|
||||
| 🔓 | Method | Endpoint | Description |
|
||||
| - | ------ | -------------------------------- | ---------------------------------------------------------------------- |
|
||||
| 🔓 | `POST` | `/signup` | [Request account](/reference/backend/signup/#request-account) |
|
||||
| 🔓 | `POST` | `/account` | [Create account](/reference/backend/signup/#create-account) |
|
||||
| 🔓 | `POST` | `/login` | [Log in](/reference/backend/login/#log-in) |
|
||||
| 🔓 | `POST` | `/reset/password` | [Recover password](/reference/backend/login/#recover-password) |
|
||||
| 🔓 | `POST` | `/confirm/login` | [Passwordless login](/reference/backend/login/#passwordless-login) |
|
||||
| 🔓 | `POST` | `/oauth/init` | [Oauth initialisation](/reference/backend/oauth/#oauth-initialisation) |
|
||||
| 🔓 | `GET` | `/oauth/callback/from/:provider` | [Oauth callback](/reference/backend/oauth/#oauth-callback) |
|
||||
| 🔓 | `POST` | `/oauth/login` | [Oauth login](/reference/backend/oauth/#oauth-login) |
|
||||
| 🔓 | `GET` | `/patrons` | [Patron list](/reference/backend/users/#patron-list) |
|
||||
|
||||
|
||||
<ReadMore root='reference/backend' box />
|
||||
53
markdown/dev/reference/backend/login/de.md
Normal file
53
markdown/dev/reference/backend/login/de.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
title: Log in
|
||||
---
|
||||
|
||||
## Log in
|
||||
```
|
||||
POST /login
|
||||
{
|
||||
'username': 'user-csfwg',
|
||||
'password': `test`
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- Both username or email address can be uses as `username`
|
||||
|
||||
## Reset password
|
||||
```
|
||||
POST /reset/password
|
||||
{
|
||||
'username': 'test@freesewing.org'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- Will send an email to the user with a link for a passwordless login.
|
||||
|
||||
## Passwordless login
|
||||
```
|
||||
POST /confirm/login
|
||||
{
|
||||
'id': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- ID is the one sent out in the confirmation email
|
||||
|
||||
This will log the user in.
|
||||
|
||||
55
markdown/dev/reference/backend/login/en.md
Normal file
55
markdown/dev/reference/backend/login/en.md
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
title: Log in
|
||||
---
|
||||
|
||||
## Log in
|
||||
```
|
||||
POST /login
|
||||
{
|
||||
'username': 'user-csfwg',
|
||||
'password': `test`
|
||||
}
|
||||
```
|
||||
On success: The account data
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- Both username or email address can be uses as `username`
|
||||
|
||||
## Reset password
|
||||
```
|
||||
POST /reset/password
|
||||
{
|
||||
'username': 'test@freesewing.org'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- Will send an email to the user with a link for a passwordless login.
|
||||
|
||||
## Passwordless login
|
||||
```
|
||||
POST /confirm/login
|
||||
{
|
||||
'id': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On success: The account data
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- ID is the one sent out in the confirmation email
|
||||
|
||||
This will log the user in.
|
||||
|
||||
53
markdown/dev/reference/backend/login/es.md
Normal file
53
markdown/dev/reference/backend/login/es.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
title: Log in
|
||||
---
|
||||
|
||||
## Log in
|
||||
```
|
||||
POST /login
|
||||
{
|
||||
'username': 'user-csfwg',
|
||||
'password': `test`
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- Both username or email address can be uses as `username`
|
||||
|
||||
## Reset password
|
||||
```
|
||||
POST /reset/password
|
||||
{
|
||||
'username': 'test@freesewing.org'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- Will send an email to the user with a link for a passwordless login.
|
||||
|
||||
## Passwordless login
|
||||
```
|
||||
POST /confirm/login
|
||||
{
|
||||
'id': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- ID is the one sent out in the confirmation email
|
||||
|
||||
This will log the user in.
|
||||
|
||||
53
markdown/dev/reference/backend/login/fr.md
Normal file
53
markdown/dev/reference/backend/login/fr.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
title: Log in
|
||||
---
|
||||
|
||||
## Log in
|
||||
```
|
||||
POST /login
|
||||
{
|
||||
'username': 'user-csfwg',
|
||||
'password': `test`
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- Both username or email address can be uses as `username`
|
||||
|
||||
## Reset password
|
||||
```
|
||||
POST /reset/password
|
||||
{
|
||||
'username': 'test@freesewing.org'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- Will send an email to the user with a link for a passwordless login.
|
||||
|
||||
## Passwordless login
|
||||
```
|
||||
POST /confirm/login
|
||||
{
|
||||
'id': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- ID is the one sent out in the confirmation email
|
||||
|
||||
This will log the user in.
|
||||
|
||||
53
markdown/dev/reference/backend/login/nl.md
Normal file
53
markdown/dev/reference/backend/login/nl.md
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
title: Log in
|
||||
---
|
||||
|
||||
## Log in
|
||||
```
|
||||
POST /login
|
||||
{
|
||||
'username': 'user-csfwg',
|
||||
'password': `test`
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- Both username or email address can be uses as `username`
|
||||
|
||||
## Reset password
|
||||
```
|
||||
POST /reset/password
|
||||
{
|
||||
'username': 'test@freesewing.org'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- Will send an email to the user with a link for a passwordless login.
|
||||
|
||||
## Passwordless login
|
||||
```
|
||||
POST /confirm/login
|
||||
{
|
||||
'id': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- Returns the same as the create account endpoint
|
||||
- ID is the one sent out in the confirmation email
|
||||
|
||||
This will log the user in.
|
||||
|
||||
82
markdown/dev/reference/backend/models/de.md
Normal file
82
markdown/dev/reference/backend/models/de.md
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
title: Models
|
||||
---
|
||||
|
||||
## Create model
|
||||
|
||||
```
|
||||
POST /models
|
||||
{
|
||||
'name': 'The model name',
|
||||
'breasts': false,
|
||||
'units': 'imperial'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'model': {
|
||||
'breasts': false,
|
||||
'units': 'imperial',
|
||||
'handle': 'dnkve',
|
||||
'user': 'ohium',
|
||||
'name': The model name',
|
||||
'createdAt': '2019-08-12T12:06:41.086Z',
|
||||
'updatedAt': '2019-08-12T12:06:41.086Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
's': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg'
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a model and returns its data.
|
||||
|
||||
## Read model
|
||||
```
|
||||
GET /models/:handle
|
||||
```
|
||||
On success: The model data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a model's data
|
||||
|
||||
## Update model
|
||||
|
||||
```
|
||||
PUT /models/:handle
|
||||
{
|
||||
'measurements': {
|
||||
'ankleCircumference': 234
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Updates the model and returns the (updated) model data.
|
||||
|
||||
## Remove model
|
||||
|
||||
```
|
||||
DELETE /models/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the model
|
||||
|
||||
83
markdown/dev/reference/backend/models/en.md
Normal file
83
markdown/dev/reference/backend/models/en.md
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
---
|
||||
title: Models
|
||||
---
|
||||
|
||||
## Create model
|
||||
|
||||
```
|
||||
POST /models
|
||||
{
|
||||
'name': 'The model name',
|
||||
'breasts': false,
|
||||
'units': 'imperial'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'model': {
|
||||
'breasts': false,
|
||||
'units': 'imperial',
|
||||
'handle': 'dnkve',
|
||||
'user': 'ohium',
|
||||
'name': The model name',
|
||||
'createdAt': '2019-08-12T12:06:41.086Z',
|
||||
'updatedAt': '2019-08-12T12:06:41.086Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
's': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg'
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a model and returns its data.
|
||||
|
||||
## Read model
|
||||
```
|
||||
GET /models/:handle
|
||||
```
|
||||
On success: The model data
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a model's data
|
||||
|
||||
## Update model
|
||||
|
||||
```
|
||||
PUT /models/:handle
|
||||
{
|
||||
'measurements': {
|
||||
'ankleCircumference': 234
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Updates the model and returns the (updated) model data.
|
||||
|
||||
## Remove model
|
||||
|
||||
```
|
||||
DELETE /models/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the model
|
||||
|
||||
82
markdown/dev/reference/backend/models/es.md
Normal file
82
markdown/dev/reference/backend/models/es.md
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
title: Models
|
||||
---
|
||||
|
||||
## Create model
|
||||
|
||||
```
|
||||
POST /models
|
||||
{
|
||||
'name': 'The model name',
|
||||
'breasts': false,
|
||||
'units': 'imperial'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'model': {
|
||||
'breasts': false,
|
||||
'units': 'imperial',
|
||||
'handle': 'dnkve',
|
||||
'user': 'ohium',
|
||||
'name': The model name',
|
||||
'createdAt': '2019-08-12T12:06:41.086Z',
|
||||
'updatedAt': '2019-08-12T12:06:41.086Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
's': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg'
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a model and returns its data.
|
||||
|
||||
## Read model
|
||||
```
|
||||
GET /models/:handle
|
||||
```
|
||||
On success: The model data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a model's data
|
||||
|
||||
## Update model
|
||||
|
||||
```
|
||||
PUT /models/:handle
|
||||
{
|
||||
'measurements': {
|
||||
'ankleCircumference': 234
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Updates the model and returns the (updated) model data.
|
||||
|
||||
## Remove model
|
||||
|
||||
```
|
||||
DELETE /models/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the model
|
||||
|
||||
82
markdown/dev/reference/backend/models/fr.md
Normal file
82
markdown/dev/reference/backend/models/fr.md
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
title: Models
|
||||
---
|
||||
|
||||
## Create model
|
||||
|
||||
```
|
||||
POST /models
|
||||
{
|
||||
'name': 'The model name',
|
||||
'breasts': false,
|
||||
'units': 'imperial'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'model': {
|
||||
'breasts': false,
|
||||
'units': 'imperial',
|
||||
'handle': 'dnkve',
|
||||
'user': 'ohium',
|
||||
'name': The model name',
|
||||
'createdAt': '2019-08-12T12:06:41.086Z',
|
||||
'updatedAt': '2019-08-12T12:06:41.086Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
's': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg'
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a model and returns its data.
|
||||
|
||||
## Read model
|
||||
```
|
||||
GET /models/:handle
|
||||
```
|
||||
On success: The model data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a model's data
|
||||
|
||||
## Update model
|
||||
|
||||
```
|
||||
PUT /models/:handle
|
||||
{
|
||||
'measurements': {
|
||||
'ankleCircumference': 234
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Updates the model and returns the (updated) model data.
|
||||
|
||||
## Remove model
|
||||
|
||||
```
|
||||
DELETE /models/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the model
|
||||
|
||||
82
markdown/dev/reference/backend/models/nl.md
Normal file
82
markdown/dev/reference/backend/models/nl.md
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
title: Models
|
||||
---
|
||||
|
||||
## Create model
|
||||
|
||||
```
|
||||
POST /models
|
||||
{
|
||||
'name': 'The model name',
|
||||
'breasts': false,
|
||||
'units': 'imperial'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'model': {
|
||||
'breasts': false,
|
||||
'units': 'imperial',
|
||||
'handle': 'dnkve',
|
||||
'user': 'ohium',
|
||||
'name': The model name',
|
||||
'createdAt': '2019-08-12T12:06:41.086Z',
|
||||
'updatedAt': '2019-08-12T12:06:41.086Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
's': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/o/ohium/models/dnkve/dnkve.svg'
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a model and returns its data.
|
||||
|
||||
## Read model
|
||||
```
|
||||
GET /models/:handle
|
||||
```
|
||||
On success: The model data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a model's data
|
||||
|
||||
## Update model
|
||||
|
||||
```
|
||||
PUT /models/:handle
|
||||
{
|
||||
'measurements': {
|
||||
'ankleCircumference': 234
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Updates the model and returns the (updated) model data.
|
||||
|
||||
## Remove model
|
||||
|
||||
```
|
||||
DELETE /models/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the model
|
||||
|
||||
48
markdown/dev/reference/backend/nl.md
Normal file
48
markdown/dev/reference/backend/nl.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: Backend API
|
||||
---
|
||||
|
||||
<Note>
|
||||
|
||||
See also: [The backend documentation](/reference/repos/backend/)
|
||||
|
||||
</Note>
|
||||
|
||||
## API Cheat sheet
|
||||
With authentication:
|
||||
|
||||
| 🔐 | Method | Endpoint | Description |
|
||||
| - | -------- | ----------------------- | ------------------------------------------------------------------------ |
|
||||
| 🔐 | `POST` | `/models` | [Creates model](/reference/backend/models/#create-model) |
|
||||
| 🔐 | `GET` | `/models/:handle` | [Read model](/reference/backend/models/#read-model) |
|
||||
| 🔐 | `PUT` | `/models/:handle` | [Update model](/reference/backend/models/#update-model) |
|
||||
| 🔐 | `DELETE` | `/models/:handle` | [Remove model](/reference/backend/models/#remove-model) |
|
||||
| 🔐 | `POST` | `/recipes` | [Create recipe](/reference/backend/recipes/#create-recipe) |
|
||||
| 🔐 | `GET` | `/recipes/:handle` | [Read recipe](/reference/backend/recipes/#read-recipe) |
|
||||
| 🔐 | `PUT` | `/recipes/:handle` | [Updates recipe](/reference/backend/recipes/#update-recipe) |
|
||||
| 🔐 | `DELETE` | `/recipes/:handle` | [Remove recipe](/reference/backend/recipes/#remove-recipe) |
|
||||
| 🔐 | `GET` | `/account` | [Load account](/reference/backend/account/#load-account) |
|
||||
| 🔐 | `PUT` | `/account` | [Update account](/reference/backend/account/#update-account) |
|
||||
| 🔐 | `DELETE` | `/account` | [Remove account](/reference/backend/account/#remove-account) |
|
||||
| 🔐 | `POST` | `/account/change/email` | [Confirm email change](/reference/backend/account/#confirm-email-change) |
|
||||
| 🔐 | `GET` | `/account/export` | [Export account](/reference/backend/account/#export-account) |
|
||||
| 🔐 | `GET` | `/account/restrict` | [Restric account](/reference/backend/account/#restrict-account) |
|
||||
| 🔐 | `GET` | `/users/:username` | [Read user profile](/reference/backend/users/#read-user-profile) |
|
||||
| 🔐 | `POST` | `/available/username` | [Is username available](/reference/backend/users/#is-username-available) |
|
||||
|
||||
Without authentication:
|
||||
|
||||
| 🔓 | Method | Endpoint | Description |
|
||||
| - | ------ | -------------------------------- | ---------------------------------------------------------------------- |
|
||||
| 🔓 | `POST` | `/signup` | [Request account](/reference/backend/signup/#request-account) |
|
||||
| 🔓 | `POST` | `/account` | [Create account](/reference/backend/signup/#create-account) |
|
||||
| 🔓 | `POST` | `/login` | [Log in](/reference/backend/login/#log-in) |
|
||||
| 🔓 | `POST` | `/reset/password` | [Recover password](/reference/backend/login/#recover-password) |
|
||||
| 🔓 | `POST` | `/confirm/login` | [Passwordless login](/reference/backend/login/#passwordless-login) |
|
||||
| 🔓 | `POST` | `/oauth/init` | [Oauth initialisation](/reference/backend/oauth/#oauth-initialisation) |
|
||||
| 🔓 | `GET` | `/oauth/callback/from/:provider` | [Oauth callback](/reference/backend/oauth/#oauth-callback) |
|
||||
| 🔓 | `POST` | `/oauth/login` | [Oauth login](/reference/backend/oauth/#oauth-login) |
|
||||
| 🔓 | `GET` | `/patrons` | [Patron list](/reference/backend/users/#patron-list) |
|
||||
|
||||
|
||||
<ReadMore root='reference/backend' box />
|
||||
52
markdown/dev/reference/backend/oauth/de.md
Normal file
52
markdown/dev/reference/backend/oauth/de.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
title: Oauth
|
||||
---
|
||||
|
||||
## Oauth initialisation
|
||||
```
|
||||
POST /oauth/init
|
||||
{
|
||||
'provider': 'github',
|
||||
'language': 'fr'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'state': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This triggers an Oauth flow
|
||||
- `provider` should be one of `google` or `github`
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- The frontend will use the state value to initialize an Oauth session. We'll check the state value when we receive the Oauth callback at the backend
|
||||
|
||||
## Oauth callback
|
||||
```
|
||||
GET /oauth/callback/from/:provider
|
||||
```
|
||||
On success: Redirects to the frontend
|
||||
|
||||
This is part of the Oauth flow. It fetches the user info from the Oauth provider. If it can't match it with a user, it will create a user account. In other words, this will handle both log in and sign up.
|
||||
|
||||
The frontend redirect will contain a confirmation ID in the URL that we'll `POST` back in the next Oauth flow step.
|
||||
|
||||
## Oauth login
|
||||
```
|
||||
POST /oauth/login
|
||||
{
|
||||
'confirmation': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the last step of the Oauth process. It logs a user in.
|
||||
|
||||
54
markdown/dev/reference/backend/oauth/en.md
Normal file
54
markdown/dev/reference/backend/oauth/en.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
title: Oauth
|
||||
---
|
||||
|
||||
## Oauth initialisation
|
||||
```
|
||||
POST /oauth/init
|
||||
{
|
||||
'provider': 'github',
|
||||
'language': 'fr'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'state': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This triggers an Oauth flow
|
||||
- `provider` should be one of `google` or `github`
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- The frontend will use the state value to initialize an Oauth session. We'll check the state value when we receive the Oauth callback at the backend
|
||||
|
||||
## Oauth callback
|
||||
```
|
||||
GET /oauth/callback/from/:provider
|
||||
```
|
||||
On success: Redirects to the frontend
|
||||
|
||||
This is part of the Oauth flow. It fetches the user info from the Oauth provider. If it can't match it with a user, it will create a user account.
|
||||
In other words, this will handle both log in and sign up.
|
||||
|
||||
The frontend redirect will contain a confirmation ID in the URL that we'll `POST` back in the next Oauth flow step.
|
||||
|
||||
## Oauth login
|
||||
```
|
||||
POST /oauth/login
|
||||
{
|
||||
'confirmation': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the last step of the Oauth process. It logs a user in.
|
||||
|
||||
52
markdown/dev/reference/backend/oauth/es.md
Normal file
52
markdown/dev/reference/backend/oauth/es.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
title: Oauth
|
||||
---
|
||||
|
||||
## Oauth initialisation
|
||||
```
|
||||
POST /oauth/init
|
||||
{
|
||||
'provider': 'github',
|
||||
'language': 'fr'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'state': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This triggers an Oauth flow
|
||||
- `provider` should be one of `google` or `github`
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- The frontend will use the state value to initialize an Oauth session. We'll check the state value when we receive the Oauth callback at the backend
|
||||
|
||||
## Oauth callback
|
||||
```
|
||||
GET /oauth/callback/from/:provider
|
||||
```
|
||||
On success: Redirects to the frontend
|
||||
|
||||
This is part of the Oauth flow. It fetches the user info from the Oauth provider. If it can't match it with a user, it will create a user account. In other words, this will handle both log in and sign up.
|
||||
|
||||
The frontend redirect will contain a confirmation ID in the URL that we'll `POST` back in the next Oauth flow step.
|
||||
|
||||
## Oauth login
|
||||
```
|
||||
POST /oauth/login
|
||||
{
|
||||
'confirmation': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the last step of the Oauth process. It logs a user in.
|
||||
|
||||
52
markdown/dev/reference/backend/oauth/fr.md
Normal file
52
markdown/dev/reference/backend/oauth/fr.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
title: Oauth
|
||||
---
|
||||
|
||||
## Oauth initialisation
|
||||
```
|
||||
POST /oauth/init
|
||||
{
|
||||
'provider': 'github',
|
||||
'language': 'fr'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'state': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This triggers an Oauth flow
|
||||
- `provider` should be one of `google` or `github`
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- The frontend will use the state value to initialize an Oauth session. We'll check the state value when we receive the Oauth callback at the backend
|
||||
|
||||
## Oauth callback
|
||||
```
|
||||
GET /oauth/callback/from/:provider
|
||||
```
|
||||
On success: Redirects to the frontend
|
||||
|
||||
This is part of the Oauth flow. It fetches the user info from the Oauth provider. If it can't match it with a user, it will create a user account. In other words, this will handle both log in and sign up.
|
||||
|
||||
The frontend redirect will contain a confirmation ID in the URL that we'll `POST` back in the next Oauth flow step.
|
||||
|
||||
## Oauth login
|
||||
```
|
||||
POST /oauth/login
|
||||
{
|
||||
'confirmation': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the last step of the Oauth process. It logs a user in.
|
||||
|
||||
52
markdown/dev/reference/backend/oauth/nl.md
Normal file
52
markdown/dev/reference/backend/oauth/nl.md
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
---
|
||||
title: Oauth
|
||||
---
|
||||
|
||||
## Oauth initialisation
|
||||
```
|
||||
POST /oauth/init
|
||||
{
|
||||
'provider': 'github',
|
||||
'language': 'fr'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'state': '5d5132041ad3f369443f1d7b'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
- This triggers an Oauth flow
|
||||
- `provider` should be one of `google` or `github`
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- The frontend will use the state value to initialize an Oauth session. We'll check the state value when we receive the Oauth callback at the backend
|
||||
|
||||
## Oauth callback
|
||||
```
|
||||
GET /oauth/callback/from/:provider
|
||||
```
|
||||
On success: Redirects to the frontend
|
||||
|
||||
This is part of the Oauth flow. It fetches the user info from the Oauth provider. If it can't match it with a user, it will create a user account. In other words, this will handle both log in and sign up.
|
||||
|
||||
The frontend redirect will contain a confirmation ID in the URL that we'll `POST` back in the next Oauth flow step.
|
||||
|
||||
## Oauth login
|
||||
```
|
||||
POST /oauth/login
|
||||
{
|
||||
'confirmation': '98e132041ad3f369443f1d3d'
|
||||
}
|
||||
```
|
||||
On success: The account data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the last step of the Oauth process. It logs a user in.
|
||||
|
||||
84
markdown/dev/reference/backend/recipes/de.md
Normal file
84
markdown/dev/reference/backend/recipes/de.md
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
---
|
||||
title: Recipes
|
||||
---
|
||||
|
||||
## Create Recipe
|
||||
|
||||
```
|
||||
POST /recipes
|
||||
{
|
||||
'name': 'The recipe name',
|
||||
'notes': 'Some notes',
|
||||
'recipe': {
|
||||
'settings': {
|
||||
'sa': 10,
|
||||
'complete': true,
|
||||
'paperless': false,
|
||||
'units': 'metric',
|
||||
'measurements': {
|
||||
'bicepsCircumference': 335,
|
||||
'centerBackNeckToWaist': 520,
|
||||
'chestCircumference': 1080,
|
||||
'"naturalWaistToHip': 145,
|
||||
'neckCircumference': 420,
|
||||
'shoulderSlope': 55,
|
||||
'shoulderToShoulder': 465,
|
||||
'hipsCircumference': 990
|
||||
}
|
||||
},
|
||||
'pattern': 'aaron',
|
||||
'model': 'dvqye'
|
||||
}
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'handle': 'abxda'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a recipe and returns its data.
|
||||
|
||||
## Read recipe
|
||||
```
|
||||
GET /recipes/:handle
|
||||
```
|
||||
On success: The recipe data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a recipe's data
|
||||
|
||||
## Update recipe
|
||||
|
||||
```
|
||||
PUT /recipes/:handle
|
||||
{
|
||||
'notes': "5 stars, would make again"
|
||||
}
|
||||
```
|
||||
|
||||
Updates the recipe and returns the (updated) recipe data.
|
||||
|
||||
## Remove recipe
|
||||
|
||||
```
|
||||
DELETE /recipes/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the recipe
|
||||
85
markdown/dev/reference/backend/recipes/en.md
Normal file
85
markdown/dev/reference/backend/recipes/en.md
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
---
|
||||
title: Recipes
|
||||
---
|
||||
|
||||
## Create Recipe
|
||||
|
||||
```
|
||||
POST /recipes
|
||||
{
|
||||
'name': 'The recipe name',
|
||||
'notes': 'Some notes',
|
||||
'recipe': {
|
||||
'settings': {
|
||||
'sa': 10,
|
||||
'complete': true,
|
||||
'paperless': false,
|
||||
'units': 'metric',
|
||||
'measurements': {
|
||||
'bicepsCircumference': 335,
|
||||
'centerBackNeckToWaist': 520,
|
||||
'chestCircumference': 1080,
|
||||
'"naturalWaistToHip': 145,
|
||||
'neckCircumference': 420,
|
||||
'shoulderSlope': 55,
|
||||
'shoulderToShoulder': 465,
|
||||
'hipsCircumference': 990
|
||||
}
|
||||
},
|
||||
'pattern': 'aaron',
|
||||
'model': 'dvqye'
|
||||
}
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'handle': 'abxda'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a recipe and returns its data.
|
||||
|
||||
## Read recipe
|
||||
```
|
||||
GET /recipes/:handle
|
||||
```
|
||||
On success: The recipe data
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a recipe's data
|
||||
|
||||
## Update recipe
|
||||
|
||||
```
|
||||
PUT /recipes/:handle
|
||||
{
|
||||
'notes': "5 stars, would make again"
|
||||
}
|
||||
```
|
||||
|
||||
Updates the recipe and returns the (updated) recipe data.
|
||||
|
||||
## Remove recipe
|
||||
|
||||
```
|
||||
DELETE /recipes/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the recipe
|
||||
84
markdown/dev/reference/backend/recipes/es.md
Normal file
84
markdown/dev/reference/backend/recipes/es.md
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
---
|
||||
title: Recipes
|
||||
---
|
||||
|
||||
## Create Recipe
|
||||
|
||||
```
|
||||
POST /recipes
|
||||
{
|
||||
'name': 'The recipe name',
|
||||
'notes': 'Some notes',
|
||||
'recipe': {
|
||||
'settings': {
|
||||
'sa': 10,
|
||||
'complete': true,
|
||||
'paperless': false,
|
||||
'units': 'metric',
|
||||
'measurements': {
|
||||
'bicepsCircumference': 335,
|
||||
'centerBackNeckToWaist': 520,
|
||||
'chestCircumference': 1080,
|
||||
'"naturalWaistToHip': 145,
|
||||
'neckCircumference': 420,
|
||||
'shoulderSlope': 55,
|
||||
'shoulderToShoulder': 465,
|
||||
'hipsCircumference': 990
|
||||
}
|
||||
},
|
||||
'pattern': 'aaron',
|
||||
'model': 'dvqye'
|
||||
}
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'handle': 'abxda'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a recipe and returns its data.
|
||||
|
||||
## Read recipe
|
||||
```
|
||||
GET /recipes/:handle
|
||||
```
|
||||
On success: The recipe data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a recipe's data
|
||||
|
||||
## Update recipe
|
||||
|
||||
```
|
||||
PUT /recipes/:handle
|
||||
{
|
||||
'notes': "5 stars, would make again"
|
||||
}
|
||||
```
|
||||
|
||||
Updates the recipe and returns the (updated) recipe data.
|
||||
|
||||
## Remove recipe
|
||||
|
||||
```
|
||||
DELETE /recipes/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the recipe
|
||||
84
markdown/dev/reference/backend/recipes/fr.md
Normal file
84
markdown/dev/reference/backend/recipes/fr.md
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
---
|
||||
title: Recipes
|
||||
---
|
||||
|
||||
## Create Recipe
|
||||
|
||||
```
|
||||
POST /recipes
|
||||
{
|
||||
'name': 'The recipe name',
|
||||
'notes': 'Some notes',
|
||||
'recipe': {
|
||||
'settings': {
|
||||
'sa': 10,
|
||||
'complete': true,
|
||||
'paperless': false,
|
||||
'units': 'metric',
|
||||
'measurements': {
|
||||
'bicepsCircumference': 335,
|
||||
'centerBackNeckToWaist': 520,
|
||||
'chestCircumference': 1080,
|
||||
'"naturalWaistToHip': 145,
|
||||
'neckCircumference': 420,
|
||||
'shoulderSlope': 55,
|
||||
'shoulderToShoulder': 465,
|
||||
'hipsCircumference': 990
|
||||
}
|
||||
},
|
||||
'pattern': 'aaron',
|
||||
'model': 'dvqye'
|
||||
}
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'handle': 'abxda'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a recipe and returns its data.
|
||||
|
||||
## Read recipe
|
||||
```
|
||||
GET /recipes/:handle
|
||||
```
|
||||
On success: The recipe data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a recipe's data
|
||||
|
||||
## Update recipe
|
||||
|
||||
```
|
||||
PUT /recipes/:handle
|
||||
{
|
||||
'notes': "5 stars, would make again"
|
||||
}
|
||||
```
|
||||
|
||||
Updates the recipe and returns the (updated) recipe data.
|
||||
|
||||
## Remove recipe
|
||||
|
||||
```
|
||||
DELETE /recipes/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the recipe
|
||||
84
markdown/dev/reference/backend/recipes/nl.md
Normal file
84
markdown/dev/reference/backend/recipes/nl.md
Normal file
|
|
@ -0,0 +1,84 @@
|
|||
---
|
||||
title: Recipes
|
||||
---
|
||||
|
||||
## Create Recipe
|
||||
|
||||
```
|
||||
POST /recipes
|
||||
{
|
||||
'name': 'The recipe name',
|
||||
'notes': 'Some notes',
|
||||
'recipe': {
|
||||
'settings': {
|
||||
'sa': 10,
|
||||
'complete': true,
|
||||
'paperless': false,
|
||||
'units': 'metric',
|
||||
'measurements': {
|
||||
'bicepsCircumference': 335,
|
||||
'centerBackNeckToWaist': 520,
|
||||
'chestCircumference': 1080,
|
||||
'"naturalWaistToHip': 145,
|
||||
'neckCircumference': 420,
|
||||
'shoulderSlope': 55,
|
||||
'shoulderToShoulder': 465,
|
||||
'hipsCircumference': 990
|
||||
}
|
||||
},
|
||||
'pattern': 'aaron',
|
||||
'model': 'dvqye'
|
||||
}
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'handle': 'abxda'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Creates a recipe and returns its data.
|
||||
|
||||
## Read recipe
|
||||
```
|
||||
GET /recipes/:handle
|
||||
```
|
||||
On success: The recipe data On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Loads a recipe's data
|
||||
|
||||
## Update recipe
|
||||
|
||||
```
|
||||
PUT /recipes/:handle
|
||||
{
|
||||
'notes': "5 stars, would make again"
|
||||
}
|
||||
```
|
||||
|
||||
Updates the recipe and returns the (updated) recipe data.
|
||||
|
||||
## Remove recipe
|
||||
|
||||
```
|
||||
DELETE /recipes/:handle
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
Removes the recipe
|
||||
97
markdown/dev/reference/backend/signup/de.md
Normal file
97
markdown/dev/reference/backend/signup/de.md
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
---
|
||||
title: Sign up
|
||||
---
|
||||
|
||||
## Request account
|
||||
```
|
||||
POST /signup
|
||||
{
|
||||
email: 'test@freesewing.org',
|
||||
password: 'test',
|
||||
language: 'en'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On error:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- This is the first half in the user sign up flow.
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- This will create (but not activate) a user account
|
||||
- This will send out an email to the user to confirm their email address
|
||||
|
||||
## Create account
|
||||
```
|
||||
POST /account
|
||||
{
|
||||
id: '5d5132041ad3f369443f1d7b'
|
||||
consent: {
|
||||
profile: true,
|
||||
model: true,
|
||||
openData: true
|
||||
}
|
||||
}
|
||||
```
|
||||
On success: The account data:
|
||||
```
|
||||
200
|
||||
{
|
||||
'account': {
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': true,
|
||||
'openData': true,
|
||||
},
|
||||
'time': {
|
||||
'login': '2019-08-12T09:41:15.823Z'
|
||||
},
|
||||
'role': 'user',
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'picture': 'csfwg.svg',
|
||||
'status': 'active',
|
||||
'handle': 'csfwg',
|
||||
'username': 'user-csfwg',
|
||||
'email': 'test@freesewing.org',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'm': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
's': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'xs': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg'
|
||||
}
|
||||
},
|
||||
'models': {},
|
||||
'recipes': {},
|
||||
'token': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZDUxMzQzYjFhZDNmMzY5NDQzZjFkOTYiLCJoYW5kbGUiOiJjc2Z3ZyIsImF1ZCI6ImZyZWVzZXdpbmcub3JnIiwiaXNzIjoiZnJlZXNld2luZy5vcmciLCJpYXQiOjE1NjU2MDI4NzV9.-u4qgiH5sEcwhSBvQ9AOxjqsJO3-Phm9t7VbPaPS7vs'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the second half of the sign up flow. The email sent to the user in the first half of the sign up flow contains a link to the (frontend) confirmation page. This will get the confirmation ID from the URL and `POST` it to the backend, along with the user's choices regarding consent for processing their personal data.
|
||||
|
||||
The `consent` object has the following properties:
|
||||
- `bool profile` : Consent for the processing of profile data
|
||||
- `bool model` : Consent for the processing of model data
|
||||
- `bool openData` : Whether or not the user allows publishing of measurements as open data
|
||||
|
||||
For more details on user consent, please consult [FreeSewing's privacy notice](https://en.freesewing.org/docs/about/privacy).
|
||||
|
||||
<Note>
|
||||
|
||||
Our frontend won't allow users to proceed without profile consent as
|
||||
storing your data requires that consent. The backend enforces this too
|
||||
|
||||
</Note>
|
||||
|
||||
97
markdown/dev/reference/backend/signup/en.md
Normal file
97
markdown/dev/reference/backend/signup/en.md
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
---
|
||||
title: Sign up
|
||||
---
|
||||
|
||||
## Request account
|
||||
```
|
||||
POST /signup
|
||||
{
|
||||
email: 'test@freesewing.org',
|
||||
password: 'test',
|
||||
language: 'en'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On error:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- This is the first half in the user sign up flow.
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- This will create (but not activate) a user account
|
||||
- This will send out an email to the user to confirm their email address
|
||||
|
||||
## Create account
|
||||
```
|
||||
POST /account
|
||||
{
|
||||
id: '5d5132041ad3f369443f1d7b'
|
||||
consent: {
|
||||
profile: true,
|
||||
model: true,
|
||||
openData: true
|
||||
}
|
||||
}
|
||||
```
|
||||
On success: The account data:
|
||||
```
|
||||
200
|
||||
{
|
||||
'account': {
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': true,
|
||||
'openData': true,
|
||||
},
|
||||
'time': {
|
||||
'login': '2019-08-12T09:41:15.823Z'
|
||||
},
|
||||
'role': 'user',
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'picture': 'csfwg.svg',
|
||||
'status': 'active',
|
||||
'handle': 'csfwg',
|
||||
'username': 'user-csfwg',
|
||||
'email': 'test@freesewing.org',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'm': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
's': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'xs': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg'
|
||||
}
|
||||
},
|
||||
'models': {},
|
||||
'recipes': {},
|
||||
'token': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZDUxMzQzYjFhZDNmMzY5NDQzZjFkOTYiLCJoYW5kbGUiOiJjc2Z3ZyIsImF1ZCI6ImZyZWVzZXdpbmcub3JnIiwiaXNzIjoiZnJlZXNld2luZy5vcmciLCJpYXQiOjE1NjU2MDI4NzV9.-u4qgiH5sEcwhSBvQ9AOxjqsJO3-Phm9t7VbPaPS7vs'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the second half of the sign up flow. The email sent to the user in the first half of the sign up flow contains a link to the (frontend) confirmation page. This will get the confirmation ID from the URL and `POST` it to
|
||||
the backend, along with the user's choices regarding consent for processing their personal data.
|
||||
|
||||
The `consent` object has the following properties:
|
||||
- `bool profile` : Consent for the processing of profile data
|
||||
- `bool model` : Consent for the processing of model data
|
||||
- `bool openData` : Whether or not the user allows publishing of measurements as open data
|
||||
|
||||
For more details on user consent, please consult [FreeSewing's privacy notice](https://en.freesewing.org/docs/about/privacy).
|
||||
|
||||
<Note>
|
||||
|
||||
Our frontend won't allow users to proceed without profile consent as
|
||||
storing your data requires that consent. The backend enforces this too
|
||||
|
||||
</Note>
|
||||
97
markdown/dev/reference/backend/signup/es.md
Normal file
97
markdown/dev/reference/backend/signup/es.md
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
---
|
||||
title: Sign up
|
||||
---
|
||||
|
||||
## Request account
|
||||
```
|
||||
POST /signup
|
||||
{
|
||||
email: 'test@freesewing.org',
|
||||
password: 'test',
|
||||
language: 'en'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On error:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- This is the first half in the user sign up flow.
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- This will create (but not activate) a user account
|
||||
- This will send out an email to the user to confirm their email address
|
||||
|
||||
## Create account
|
||||
```
|
||||
POST /account
|
||||
{
|
||||
id: '5d5132041ad3f369443f1d7b'
|
||||
consent: {
|
||||
profile: true,
|
||||
model: true,
|
||||
openData: true
|
||||
}
|
||||
}
|
||||
```
|
||||
On success: The account data:
|
||||
```
|
||||
200
|
||||
{
|
||||
'account': {
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': true,
|
||||
'openData': true,
|
||||
},
|
||||
'time': {
|
||||
'login': '2019-08-12T09:41:15.823Z'
|
||||
},
|
||||
'role': 'user',
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'picture': 'csfwg.svg',
|
||||
'status': 'active',
|
||||
'handle': 'csfwg',
|
||||
'username': 'user-csfwg',
|
||||
'email': 'test@freesewing.org',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'm': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
's': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'xs': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg'
|
||||
}
|
||||
},
|
||||
'models': {},
|
||||
'recipes': {},
|
||||
'token': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZDUxMzQzYjFhZDNmMzY5NDQzZjFkOTYiLCJoYW5kbGUiOiJjc2Z3ZyIsImF1ZCI6ImZyZWVzZXdpbmcub3JnIiwiaXNzIjoiZnJlZXNld2luZy5vcmciLCJpYXQiOjE1NjU2MDI4NzV9.-u4qgiH5sEcwhSBvQ9AOxjqsJO3-Phm9t7VbPaPS7vs'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the second half of the sign up flow. The email sent to the user in the first half of the sign up flow contains a link to the (frontend) confirmation page. This will get the confirmation ID from the URL and `POST` it to the backend, along with the user's choices regarding consent for processing their personal data.
|
||||
|
||||
The `consent` object has the following properties:
|
||||
- `bool profile` : Consent for the processing of profile data
|
||||
- `bool model` : Consent for the processing of model data
|
||||
- `bool openData` : Whether or not the user allows publishing of measurements as open data
|
||||
|
||||
For more details on user consent, please consult [FreeSewing's privacy notice](https://en.freesewing.org/docs/about/privacy).
|
||||
|
||||
<Note>
|
||||
|
||||
Our frontend won't allow users to proceed without profile consent as
|
||||
storing your data requires that consent. The backend enforces this too
|
||||
|
||||
</Note>
|
||||
|
||||
97
markdown/dev/reference/backend/signup/fr.md
Normal file
97
markdown/dev/reference/backend/signup/fr.md
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
---
|
||||
title: Sign up
|
||||
---
|
||||
|
||||
## Request account
|
||||
```
|
||||
POST /signup
|
||||
{
|
||||
email: 'test@freesewing.org',
|
||||
password: 'test',
|
||||
language: 'en'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On error:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- This is the first half in the user sign up flow.
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- This will create (but not activate) a user account
|
||||
- This will send out an email to the user to confirm their email address
|
||||
|
||||
## Create account
|
||||
```
|
||||
POST /account
|
||||
{
|
||||
id: '5d5132041ad3f369443f1d7b'
|
||||
consent: {
|
||||
profile: true,
|
||||
model: true,
|
||||
openData: true
|
||||
}
|
||||
}
|
||||
```
|
||||
On success: The account data:
|
||||
```
|
||||
200
|
||||
{
|
||||
'account': {
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': true,
|
||||
'openData': true,
|
||||
},
|
||||
'time': {
|
||||
'login': '2019-08-12T09:41:15.823Z'
|
||||
},
|
||||
'role': 'user',
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'picture': 'csfwg.svg',
|
||||
'status': 'active',
|
||||
'handle': 'csfwg',
|
||||
'username': 'user-csfwg',
|
||||
'email': 'test@freesewing.org',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'm': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
's': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'xs': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg'
|
||||
}
|
||||
},
|
||||
'models': {},
|
||||
'recipes': {},
|
||||
'token': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZDUxMzQzYjFhZDNmMzY5NDQzZjFkOTYiLCJoYW5kbGUiOiJjc2Z3ZyIsImF1ZCI6ImZyZWVzZXdpbmcub3JnIiwiaXNzIjoiZnJlZXNld2luZy5vcmciLCJpYXQiOjE1NjU2MDI4NzV9.-u4qgiH5sEcwhSBvQ9AOxjqsJO3-Phm9t7VbPaPS7vs'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the second half of the sign up flow. The email sent to the user in the first half of the sign up flow contains a link to the (frontend) confirmation page. This will get the confirmation ID from the URL and `POST` it to the backend, along with the user's choices regarding consent for processing their personal data.
|
||||
|
||||
The `consent` object has the following properties:
|
||||
- `bool profile` : Consent for the processing of profile data
|
||||
- `bool model` : Consent for the processing of model data
|
||||
- `bool openData` : Whether or not the user allows publishing of measurements as open data
|
||||
|
||||
For more details on user consent, please consult [FreeSewing's privacy notice](https://en.freesewing.org/docs/about/privacy).
|
||||
|
||||
<Note>
|
||||
|
||||
Our frontend won't allow users to proceed without profile consent as
|
||||
storing your data requires that consent. The backend enforces this too
|
||||
|
||||
</Note>
|
||||
|
||||
97
markdown/dev/reference/backend/signup/nl.md
Normal file
97
markdown/dev/reference/backend/signup/nl.md
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
---
|
||||
title: Sign up
|
||||
---
|
||||
|
||||
## Request account
|
||||
```
|
||||
POST /signup
|
||||
{
|
||||
email: 'test@freesewing.org',
|
||||
password: 'test',
|
||||
language: 'en'
|
||||
}
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
```
|
||||
On error:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
- This is the first half in the user sign up flow.
|
||||
- `language` should be one of the [configured language codes](https://github.com/freesewing/backend/blob/develop/src/config/index.js#L32)
|
||||
- This will create (but not activate) a user account
|
||||
- This will send out an email to the user to confirm their email address
|
||||
|
||||
## Create account
|
||||
```
|
||||
POST /account
|
||||
{
|
||||
id: '5d5132041ad3f369443f1d7b'
|
||||
consent: {
|
||||
profile: true,
|
||||
model: true,
|
||||
openData: true
|
||||
}
|
||||
}
|
||||
```
|
||||
On success: The account data:
|
||||
```
|
||||
200
|
||||
{
|
||||
'account': {
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'consent': {
|
||||
'profile': true,
|
||||
'model': true,
|
||||
'openData': true,
|
||||
},
|
||||
'time': {
|
||||
'login': '2019-08-12T09:41:15.823Z'
|
||||
},
|
||||
'role': 'user',
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'picture': 'csfwg.svg',
|
||||
'status': 'active',
|
||||
'handle': 'csfwg',
|
||||
'username': 'user-csfwg',
|
||||
'email': 'test@freesewing.org',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'm': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
's': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg',
|
||||
'xs': 'https://static.freesewing.org/users/c/csfwg/csfwg.svg'
|
||||
}
|
||||
},
|
||||
'models': {},
|
||||
'recipes': {},
|
||||
'token': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI1ZDUxMzQzYjFhZDNmMzY5NDQzZjFkOTYiLCJoYW5kbGUiOiJjc2Z3ZyIsImF1ZCI6ImZyZWVzZXdpbmcub3JnIiwiaXNzIjoiZnJlZXNld2luZy5vcmciLCJpYXQiOjE1NjU2MDI4NzV9.-u4qgiH5sEcwhSBvQ9AOxjqsJO3-Phm9t7VbPaPS7vs'
|
||||
}
|
||||
```
|
||||
On failure:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
This is the second half of the sign up flow. The email sent to the user in the first half of the sign up flow contains a link to the (frontend) confirmation page. This will get the confirmation ID from the URL and `POST` it to the backend, along with the user's choices regarding consent for processing their personal data.
|
||||
|
||||
The `consent` object has the following properties:
|
||||
- `bool profile` : Consent for the processing of profile data
|
||||
- `bool model` : Consent for the processing of model data
|
||||
- `bool openData` : Whether or not the user allows publishing of measurements as open data
|
||||
|
||||
For more details on user consent, please consult [FreeSewing's privacy notice](https://en.freesewing.org/docs/about/privacy).
|
||||
|
||||
<Note>
|
||||
|
||||
Our frontend won't allow users to proceed without profile consent as
|
||||
storing your data requires that consent. The backend enforces this too
|
||||
|
||||
</Note>
|
||||
|
||||
90
markdown/dev/reference/backend/users/de.md
Normal file
90
markdown/dev/reference/backend/users/de.md
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
---
|
||||
title: Users
|
||||
---
|
||||
|
||||
## Read user profile
|
||||
```
|
||||
GET /users/:username
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'handle': 'rracx',
|
||||
'username': 'admin',
|
||||
'createdAt': '2019-08-12T07:40:32.435Z',
|
||||
'updatedAt': '2019-08-12T09:23:48.930Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
's': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Load the profile data of a user. It expects one parameter in the URL of the `GET` request:
|
||||
|
||||
| Variable | Description |
|
||||
| ---------- | ----------------------------------------------------- |
|
||||
| `username` | The username of the user to load the profile data for |
|
||||
|
||||
## Is username availbable
|
||||
|
||||
```
|
||||
POST /available/username
|
||||
{
|
||||
username: 'username to check'
|
||||
}
|
||||
```
|
||||
Username available:
|
||||
```
|
||||
200
|
||||
```
|
||||
Username not available:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Patron list
|
||||
|
||||
```
|
||||
GET /patrons
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'2': [
|
||||
],
|
||||
'4': [],
|
||||
'8': [
|
||||
{
|
||||
'handle': 'joost',
|
||||
'username': 'joost',
|
||||
'bio':"If something doesn't work around here, that's probably my fault",
|
||||
'social': {
|
||||
'twitter': 'j__st',
|
||||
'instagram': 'joostdecock',
|
||||
'github': 'joostdecock'
|
||||
},
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/j/joost/joost.jpg',
|
||||
'm': 'https://static.freesewing.org/users/j/joost/m-joost.jpg',
|
||||
's': 'https://static.freesewing.org/users/j/joost/s-joost.jpg',
|
||||
'xs': 'https://static.freesewing.org/users/j/joost/xs-joost.jpg'
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- Retrieves the list of [FreeSewing patrons](https://freesewing.org/patrons).
|
||||
- Returns an array per tier
|
||||
|
||||
90
markdown/dev/reference/backend/users/en.md
Normal file
90
markdown/dev/reference/backend/users/en.md
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
---
|
||||
title: Users
|
||||
---
|
||||
|
||||
## Read user profile
|
||||
```
|
||||
GET /users/:username
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'handle': 'rracx',
|
||||
'username': 'admin',
|
||||
'createdAt': '2019-08-12T07:40:32.435Z',
|
||||
'updatedAt': '2019-08-12T09:23:48.930Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
's': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Load the profile data of a user. It expects one parameter in the URL of the `GET` request:
|
||||
|
||||
| Variable | Description |
|
||||
|------------|-------------|
|
||||
| `username` | The username of the user to load the profile data for |
|
||||
|
||||
## Is username availbable
|
||||
|
||||
```
|
||||
POST /available/username
|
||||
{
|
||||
username: 'username to check'
|
||||
}
|
||||
```
|
||||
Username available:
|
||||
```
|
||||
200
|
||||
```
|
||||
Username not available:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Patron list
|
||||
|
||||
```
|
||||
GET /patrons
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'2': [
|
||||
],
|
||||
'4': [],
|
||||
'8': [
|
||||
{
|
||||
'handle': 'joost',
|
||||
'username': 'joost',
|
||||
'bio':"If something doesn't work around here, that's probably my fault",
|
||||
'social': {
|
||||
'twitter': 'j__st',
|
||||
'instagram': 'joostdecock',
|
||||
'github': 'joostdecock'
|
||||
},
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/j/joost/joost.jpg',
|
||||
'm': 'https://static.freesewing.org/users/j/joost/m-joost.jpg',
|
||||
's': 'https://static.freesewing.org/users/j/joost/s-joost.jpg',
|
||||
'xs': 'https://static.freesewing.org/users/j/joost/xs-joost.jpg'
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- Retrieves the list of [FreeSewing patrons](https://freesewing.org/patrons).
|
||||
- Returns an array per tier
|
||||
|
||||
90
markdown/dev/reference/backend/users/es.md
Normal file
90
markdown/dev/reference/backend/users/es.md
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
---
|
||||
title: Users
|
||||
---
|
||||
|
||||
## Read user profile
|
||||
```
|
||||
GET /users/:username
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'handle': 'rracx',
|
||||
'username': 'admin',
|
||||
'createdAt': '2019-08-12T07:40:32.435Z',
|
||||
'updatedAt': '2019-08-12T09:23:48.930Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
's': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Load the profile data of a user. It expects one parameter in the URL of the `GET` request:
|
||||
|
||||
| Variable | Description |
|
||||
| ---------- | ----------------------------------------------------- |
|
||||
| `username` | The username of the user to load the profile data for |
|
||||
|
||||
## Is username availbable
|
||||
|
||||
```
|
||||
POST /available/username
|
||||
{
|
||||
username: 'username to check'
|
||||
}
|
||||
```
|
||||
Username available:
|
||||
```
|
||||
200
|
||||
```
|
||||
Username not available:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Patron list
|
||||
|
||||
```
|
||||
GET /patrons
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'2': [
|
||||
],
|
||||
'4': [],
|
||||
'8': [
|
||||
{
|
||||
'handle': 'joost',
|
||||
'username': 'joost',
|
||||
'bio':"If something doesn't work around here, that's probably my fault",
|
||||
'social': {
|
||||
'twitter': 'j__st',
|
||||
'instagram': 'joostdecock',
|
||||
'github': 'joostdecock'
|
||||
},
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/j/joost/joost.jpg',
|
||||
'm': 'https://static.freesewing.org/users/j/joost/m-joost.jpg',
|
||||
's': 'https://static.freesewing.org/users/j/joost/s-joost.jpg',
|
||||
'xs': 'https://static.freesewing.org/users/j/joost/xs-joost.jpg'
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- Retrieves the list of [FreeSewing patrons](https://freesewing.org/patrons).
|
||||
- Returns an array per tier
|
||||
|
||||
90
markdown/dev/reference/backend/users/fr.md
Normal file
90
markdown/dev/reference/backend/users/fr.md
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
---
|
||||
title: Users
|
||||
---
|
||||
|
||||
## Read user profile
|
||||
```
|
||||
GET /users/:username
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'handle': 'rracx',
|
||||
'username': 'admin',
|
||||
'createdAt': '2019-08-12T07:40:32.435Z',
|
||||
'updatedAt': '2019-08-12T09:23:48.930Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
's': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Load the profile data of a user. It expects one parameter in the URL of the `GET` request:
|
||||
|
||||
| Variable | Description |
|
||||
| ---------- | ----------------------------------------------------- |
|
||||
| `username` | The username of the user to load the profile data for |
|
||||
|
||||
## Is username availbable
|
||||
|
||||
```
|
||||
POST /available/username
|
||||
{
|
||||
username: 'username to check'
|
||||
}
|
||||
```
|
||||
Username available:
|
||||
```
|
||||
200
|
||||
```
|
||||
Username not available:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Patron list
|
||||
|
||||
```
|
||||
GET /patrons
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'2': [
|
||||
],
|
||||
'4': [],
|
||||
'8': [
|
||||
{
|
||||
'handle': 'joost',
|
||||
'username': 'joost',
|
||||
'bio':"If something doesn't work around here, that's probably my fault",
|
||||
'social': {
|
||||
'twitter': 'j__st',
|
||||
'instagram': 'joostdecock',
|
||||
'github': 'joostdecock'
|
||||
},
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/j/joost/joost.jpg',
|
||||
'm': 'https://static.freesewing.org/users/j/joost/m-joost.jpg',
|
||||
's': 'https://static.freesewing.org/users/j/joost/s-joost.jpg',
|
||||
'xs': 'https://static.freesewing.org/users/j/joost/xs-joost.jpg'
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- Retrieves the list of [FreeSewing patrons](https://freesewing.org/patrons).
|
||||
- Returns an array per tier
|
||||
|
||||
90
markdown/dev/reference/backend/users/nl.md
Normal file
90
markdown/dev/reference/backend/users/nl.md
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
---
|
||||
title: Users
|
||||
---
|
||||
|
||||
## Read user profile
|
||||
```
|
||||
GET /users/:username
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'settings': {
|
||||
'language': 'en',
|
||||
'units': 'metric'
|
||||
},
|
||||
'patron': 0,
|
||||
'bio': '',
|
||||
'handle': 'rracx',
|
||||
'username': 'admin',
|
||||
'createdAt': '2019-08-12T07:40:32.435Z',
|
||||
'updatedAt': '2019-08-12T09:23:48.930Z',
|
||||
'pictureUris': {
|
||||
'l': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'm': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
's': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg',
|
||||
'xs': 'https://static.she.freesewing.org/users/r/rracx/rracx.svg'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Load the profile data of a user. It expects one parameter in the URL of the `GET` request:
|
||||
|
||||
| Variable | Description |
|
||||
| ---------- | ----------------------------------------------------- |
|
||||
| `username` | The username of the user to load the profile data for |
|
||||
|
||||
## Is username availbable
|
||||
|
||||
```
|
||||
POST /available/username
|
||||
{
|
||||
username: 'username to check'
|
||||
}
|
||||
```
|
||||
Username available:
|
||||
```
|
||||
200
|
||||
```
|
||||
Username not available:
|
||||
```
|
||||
400
|
||||
```
|
||||
|
||||
## Patron list
|
||||
|
||||
```
|
||||
GET /patrons
|
||||
```
|
||||
On success:
|
||||
```
|
||||
200
|
||||
{
|
||||
'2': [
|
||||
],
|
||||
'4': [],
|
||||
'8': [
|
||||
{
|
||||
'handle': 'joost',
|
||||
'username': 'joost',
|
||||
'bio':"If something doesn't work around here, that's probably my fault",
|
||||
'social': {
|
||||
'twitter': 'j__st',
|
||||
'instagram': 'joostdecock',
|
||||
'github': 'joostdecock'
|
||||
},
|
||||
'pictureUris': {
|
||||
'l': 'https://static.freesewing.org/users/j/joost/joost.jpg',
|
||||
'm': 'https://static.freesewing.org/users/j/joost/m-joost.jpg',
|
||||
's': 'https://static.freesewing.org/users/j/joost/s-joost.jpg',
|
||||
'xs': 'https://static.freesewing.org/users/j/joost/xs-joost.jpg'
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- Retrieves the list of [FreeSewing patrons](https://freesewing.org/patrons).
|
||||
- Returns an array per tier
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue