paramdb/paramdb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix readme

Browse Source
This commit is contained in:
noccy
2024-09-27 17:40:05 +02:00
parent ac57a59f2f
commit d195834e05
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -3
View File
@@ -52,6 +52,8 @@ Content-Type: application/json
### Retrieve current values
Retrieve all current values by getting `/{collection}`. If all values in a key have a validity span and none matches, they key will not be included in the response.
```json
GET /businessinfo
@@ -66,6 +68,8 @@ Query params:
### Retrieve all values
Retrieve all keys and values, together with the value IDs by getting `/{collection}/all`.
```json
GET /businessinfo/all
@@ -93,7 +97,7 @@ Query params:
### Delete value
Delete by posting an array of value IDs and keys to delete.
Delete by posting an array of value IDs and keys to delete to `/{collection}/delete`.
```json
POST /businessinfo/delete
@@ -104,7 +108,7 @@ Content-Type: application/json
### Update a value
Update by including an existing id with the set request.
Update by including an existing id with the set request posted to `/{collection}`.
```json
POST /businessinfo
@@ -124,7 +128,7 @@ Content-Type: application/json
### Delete a colleciton
Update by including an existing id with the set request.
Purge a collection by posting to `/{collection}/purge`.
```json
POST /businessinfo/purge