fix: Multiple typo corrections to backend api docs
This commit is contained in:
parent
da5cd671dd
commit
3631bec601
18 changed files with 51 additions and 58 deletions
|
@ -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(
|
|||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue