VSinerva/freesewing
1
0
Fork 0
Code Activity

Revert "chore: Linting for markdown and js"

Browse source 
This reverts commit 1c92e0f655.
This commit is contained in:
joostdecock 2021-10-17 18:26:00 +02:00
parent 994874fa72
commit cba1ab19c8
6627 changed files with 25791 additions and 24211 deletions
Download patch file Download diff file Expand all files Collapse all files

154
markdown/dev/reference/backend/account/en.md
View file

@ -1,104 +1,110 @@
***
## title: Account
---
title: Account
---
## Load account
GET /account
```
GET /account
```
On success: The account data
On failure:
400
```
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
},
```
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.
```
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
```
DELETE /account
```
On success:
204
```
204
```
On failure:
400
```
400
```
Removes the account and all user's data. Will also trigger a goodbye email.
## Confirm email change
POST /account/change/email
{
'id': '98e132041ad3f369443f1d3d'
}
```
POST /account/change/email
{
'id': '98e132041ad3f369443f1d3d'
}
```
On success: The account data
On failure:
400
```
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'
}
```
GET /account/export
```
On success:
```
200
{
'export': 'https://static.freesewing.org/tmp/msypflkyyw/export.zip'
}
```
On failure:
```
400
```
400
Will export the user data and publish it for download.
Will export the user data and publish it for download.
## Restrict account
GET /account/restrict
```
GET /account/restrict
```
On success:
200
```
200
```
On failure:
400
```
400
```
Will lock the user account, thereby restricting processing of their data.

7
markdown/dev/reference/backend/en.md
View file

@ -1,9 +1,8 @@
***
---
title: Backend API
for: developers
about: Documentation for our backend REST API
---------------------------------------------
---
<Fixme>This documentation is outdated</Fixme>
@ -14,7 +13,6 @@ See also: [The backend documentation](/reference/repos/backend/)
</Note>
## API Cheat sheet
With authentication:
|🔐| Method | Endpoint | Description |
@ -50,4 +48,5 @@ Without authentication:
|🔓|`POST`|`/oauth/login`| [Oauth login](/reference/backend/oauth/#oauth-login) |
|🔓|`GET`|`/patrons`| [Patron list](/reference/backend/users/#patron-list) |
<ReadMore root='reference/backend' box />

78
markdown/dev/reference/backend/login/en.md
View file

@ -1,53 +1,55 @@
***
## title: Log in
---
title: Log in
---
## Log in
POST /login
{
'username': 'user-csfwg',
'password': `test`
}
```
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`
```
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'
}
```
POST /reset/password
{
'username': 'test@freesewing.org'
}
```
On success:
200
```
200
```
On failure:
```
400
```
400
* Will send an email to the user with a link for a passwordless login.
- Will send an email to the user with a link for a passwordless login.
## Passwordless login
POST /confirm/login
{
'id': '5d5132041ad3f369443f1d7b'
}
```
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
```
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.

106
markdown/dev/reference/backend/models/en.md
View file

@ -1,75 +1,83 @@
***
## title: Models
---
title: Models
---
## Create model
POST /models
{
'name': 'The model name',
'breasts': false,
'units': 'imperial'
}
```
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'
}
}
```
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
```
400
```
Creates a model and returns its data.
## Read model
GET /models/:handle
```
GET /models/:handle
```
On success: The model data
On failure:
400
```
400
```
Loads a model's data
## Update model
PUT /models/:handle
{
'measurements': {
'ankleCircumference': 234
}
}
```
PUT /models/:handle
{
'measurements': {
'ankleCircumference': 234
}
}
```
Updates the model and returns the (updated) model data.
## Remove model
DELETE /models/:handle
```
DELETE /models/:handle
```
On success:
200
```
200
```
On failure:
400
```
400
```
Removes the model

72
markdown/dev/reference/backend/oauth/en.md
View file

@ -1,52 +1,54 @@
***
## title: Oauth
---
title: Oauth
---
## Oauth initialisation
POST /oauth/init
{
'provider': 'github',
'language': 'fr'
}
```
POST /oauth/init
{
'provider': 'github',
'language': 'fr'
}
```
On success:
200
{
'state': '5d5132041ad3f369443f1d7b'
}
```
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
```
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
```
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.\
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'
}
```
POST /oauth/login
{
'confirmation': '98e132041ad3f369443f1d3d'
}
```
On success: The account data
On failure:
400
```
400
```
This is the last step of the Oauth process. It logs a user in.

111
markdown/dev/reference/backend/recipes/en.md
View file

@ -1,78 +1,85 @@
***
## title: Recipes
---
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'
```
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'
}
```
200
{
'handle': 'abxda'
}
```
On failure:
400
```
400
```
Creates a recipe and returns its data.
## Read recipe
GET /recipes/:handle
```
GET /recipes/:handle
```
On success: The recipe data
On failure:
400
```
400
```
Loads a recipe's data
## Update recipe
PUT /recipes/:handle
{
'notes': "5 stars, would make again"
}
```
PUT /recipes/:handle
{
'notes': "5 stars, would make again"
}
```
Updates the recipe and returns the (updated) recipe data.
## Remove recipe
DELETE /recipes/:handle
```
DELETE /recipes/:handle
```
On success:
200
```
200
```
On failure:
400
```
400
```
Removes the recipe

149
markdown/dev/reference/backend/signup/en.md
View file

@ -1,90 +1,91 @@
***
## title: Sign up
---
title: Sign up
---
## Request account
POST /signup
{
email: 'test@freesewing.org',
password: 'test',
language: 'en'
}
On success:
200
```
POST /signup
{
email: 'test@freesewing.org',
password: 'test',
language: 'en'
}
```
On success:
```
200
```
On error:
```
400
```
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
- 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
}
}
```
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'
}
```
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
```
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
- `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).

138
markdown/dev/reference/backend/users/en.md
View file

@ -1,84 +1,90 @@
***
## title: Users
---
title: Users
---
## Read user profile
GET /users/:username
```
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'
}
}
```
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 |\
|------------|-------------|\
| Variable | Description |
|------------|-------------|
| `username` | The username of the user to load the profile data for |
## Is username availbable
POST /available/username
{
username: 'username to check'
}
```
POST /available/username
{
username: 'username to check'
}
```
Username available:
200
```
200
```
Username not available:
400
```
400
```
## Patron list
GET /patrons
```
GET /patrons
```
On success:
200
```
200
{
'2': [
],
'4': [],
'8': [
{
'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'
}
}
]
'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
* Retrieves the list of [FreeSewing patrons](https://freesewing.org/patrons).
* Returns an array per tier