VSinerva/freesewing
1
0
Fork 0
Code Activity

fix: Multiple typo corrections to backend api docs

Browse source
This commit is contained in:
Darigov Research 2022-11-26 18:48:43 +00:00
parent da5cd671dd
commit 3631bec601
18 changed files with 51 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

7
markdown/dev/reference/backend/api/patterns/clone/en.md
View file

@ -28,9 +28,9 @@ Creating a new Person is possible via these endpoints:
| <Method post /> | `/patterns/:id/clone/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) |
| <Method post /> | `/patterns/:id/clone/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) |
## Request url
## Request URL
The url should contain the ID of the Pattern you wish to remove.
The URL should contain the ID of the Pattern you wish to remove.
It replaces the `:id` placeholder in the [endpoints listed above](#endpoints).
## Response status codes
@ -55,7 +55,7 @@ in the response body should indicate the nature of the problem.
| Value | Type | Description |
| ------------------- | -------- | ----------- |
| `result` | String | Either `success` or `error` |
| `error` | String | Will give info on the nature of the error. Only set if an error occured. |
| `error` | String | Will give info on the nature of the error. Only set if an error occurred. |
| `pattern.id` | Number | The ID of the Pattern |
| `pattern.createdAt` | String | Date string indicating the moment the pattern was created |
| `pattern.data` | Object | Any additional data that was stored with Pattern data |
@ -107,4 +107,3 @@ const clone = axios.post(
}
}
```

2
markdown/dev/reference/backend/api/patterns/create/en.md
View file

@ -52,7 +52,7 @@ in the response body should indicate the nature of the problem.
| Value | Type | Description |
| ------------------- | -------- | ----------- |
| `result` | String | Either `success` or `error` |
| `error` | String | Will give info on the nature of the error. Only set if an error occured. |
| `error` | String | Will give info on the nature of the error. Only set if an error occurred. |
| `pattern.id` | Number | The ID of the Pattern |
| `pattern.createdAt` | String | Date string indicating the moment the pattern was created |
| `pattern.data` | Object | Any additional data that was stored with Pattern data |

5
markdown/dev/reference/backend/api/patterns/delete/en.md
View file

@ -18,9 +18,9 @@ Deleting a Pattern is possible via these endpoints:
| <Method delete /> | `/patterns/:id/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) |
| <Method delete /> | `/patterns/:id/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) |
## Request url
## Request URL
The url should contain the ID of the Pattern you wish to remove.
The URL should contain the ID of the Pattern you wish to remove.
It replaces the `:id` placeholder in the [endpoints listed above](#endpoints).
## Response status codes
@ -56,4 +56,3 @@ await axios.delete(
These endpoints return status code <StatusCode status="204"/> (no content) on
success, with no response body.
</Note>

3
markdown/dev/reference/backend/api/patterns/en.md
View file

@ -24,11 +24,10 @@ Keep in mind that:
- The `notes` property is intended to be used by the user to add notes about
their pattern. It will only accept data of type `string`.
- The `data` property is intended to allow frontend developers to store
additional data about the pattern. It wil only accept data of type `object`.
additional data about the pattern. It will only accept data of type `object`.
### The `settings` property should hold the pattern settings
The `settings` property should hold [a settings object](/reference/settings)
that can be passed to [the Pattern
constructor](/reference/api/pattern#creating-a-pattern).

8
markdown/dev/reference/backend/api/patterns/read/en.md
View file

@ -2,7 +2,7 @@
title: Read a Pattern
---
Reads an existing Pattern.
Reads an existing Pattern.
## Access control
@ -28,9 +28,9 @@ Reading a Pattern is possible via these endpoints:
| <Method get /> | `/patterns/:id/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) |
| <Method get /> | `/patterns/:id/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) |
## Request url
## Request URL
The url should contain the ID of the Pattern you wish to read.
The URL should contain the ID of the Pattern you wish to read.
It replaces the `:id` placeholder in the [endpoints listed above](#endpoints).
## Response status codes
@ -56,7 +56,7 @@ in the response body should indicate the nature of the problem.
| Value | Type | Description |
| ------------------- | -------- | ----------- |
| `result` | String | Either `success` or `error` |
| `error` | String | Will give info on the nature of the error. Only set if an error occured. |
| `error` | String | Will give info on the nature of the error. Only set if an error occurred. |
| `pattern.id` | Number | The ID of the Pattern |
| `pattern.createdAt` | String | Date string indicating the moment the pattern was created |
| `pattern.data` | Object | Any additional data that was stored with Pattern data |

6
markdown/dev/reference/backend/api/patterns/update/en.md
View file

@ -18,9 +18,9 @@ Updating an existing Pattern is possible via these endpoints:
| <Method put /> | `/patterns/:id/jwt` | [JSON Web Token](/reference/backend/api/authentication#jwt-authentication) |
| <Method put /> | `/patterns/:id/key` | [API Key & Secret](/reference/backend/api/authentication#key-authentication) |
## Request url
## Request URL
The url should contain the ID of the Pattern you wish to remove.
The URL should contain the ID of the Pattern you wish to remove.
It replaces the `:id` placeholder in the [endpoints listed above](#endpoints).
## Request body
@ -57,7 +57,7 @@ in the response body should indicate the nature of the problem.
| Value | Type | Description |
| ------------------- | -------- | ----------- |
| `result` | String | Either `success` or `error` |
| `error` | String | Will give info on the nature of the error. Only set if an error occured. |
| `error` | String | Will give info on the nature of the error. Only set if an error occurred. |
| `pattern.id` | Number | The ID of the Pattern |
| `pattern.createdAt` | String | Date string indicating the moment the pattern was created |
| `pattern.data` | Object | Any additional data that was stored with Pattern data |