Skip to content

Commit 1183382

Browse files
committed
improve docs
1 parent 67b2141 commit 1183382

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/JSON REST API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A valid JSON-RPC request is sent via HTTP with the HTTP header `Content-Type: ap
2121
## `customerdb.read` - get customers from server
2222
### Parameters
2323
- `diff_since` (optional) - only return records changed since this date
24-
- `files` (optional, default `true` for backward compatibility) - boolean indicating wether to include customer files in the response (`true` is deprecated and will be removed in a future release, use `customerdb.read.customer` instead for getting file of a specific customer)
24+
- `files` (optional, default `true` for backward compatibility) - boolean indicating whether to include customer files in the response (`true` is deprecated and will be removed in a future release, use `customerdb.read.customer` instead for getting file of a specific customer)
2525
- `username` - username for authentication
2626
- `password` - password for authentication
2727
- `playstore_token` (optional) - Google Play Store token for server-side subscription payment check (not of interest for self-hosted servers)
@@ -80,7 +80,7 @@ A valid JSON-RPC request is sent via HTTP with the HTTP header `Content-Type: ap
8080
```
8181

8282
## `customerdb.read.customer` - get details of a customer with files
83-
Use this method to get customer's files. It is necessary to query files per customer individually because otherwise, the JSON response with files for all customers can get too big and cause memory error on server and client.
83+
Use this method to get customer's files. It is necessary to query files per customer individually because otherwise, the JSON response with files for all customers can get too big and cause JSON parsing errors on server and/or client.
8484
### Parameters
8585
- `customer_id` - the ID of the customer to get
8686
- `username` - username for authentication

0 commit comments

Comments
 (0)