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

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 |