Skip to content

Commit 53e4b3c

Browse files
authored
Merge pull request #212 from satti-hari-krishna-reddy/master
Updated success responses for get and set cache endpoints in Datastore API docs
2 parents ed0f1ad + 32daa3d commit 53e4b3c

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/API.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ curl https://shuffler.io/api/v1/orgs/{org_id}/set_cache -H "Authorization: Beare
258258

259259
**Success response**
260260
```json
261-
{"success": true}
261+
{"success": true, "keys_existed": [{"key": "hi", "existed": true }]}
262262
```
263263

264264
### Add multiple keys
@@ -267,13 +267,13 @@ To add a key to a specific category, add `"category": "name"` to the JSON body.
267267
Methods: POST, PUT
268268

269269
```bash
270-
curl https://shuffler.io/api/v2/datastore?bulk=true -H "Authorization: Bearer APIKEY" -d '[{"key":"hi", "value":"1234", "category": "category"}]'
270+
curl https://shuffler.io/api/v2/datastore?bulk=true -H "Authorization: Bearer APIKEY" -d '[{"key":"testKey1", "value":"1234", "category": "category"}, {"key":"testKey2", "value":"1234", "category": "category"}]'
271271
```
272272

273273

274274
**Success response**
275275
```json
276-
{"success": true}
276+
{"success": true, "keys_existed": [{"key": "testKey1", "existed": true }, { "key": "testKey2", "existed": false}]}
277277
```
278278

279279

@@ -291,7 +291,9 @@ curl https://shuffler.io/api/v1/orgs/{org_id}/get_cache -H "Authorization: Beare
291291

292292
**Success response**
293293
```json
294-
{"success":false,"workflow_id":"99951014-f0b1-473d-a474-4dc9afecaa75","execution_id":"f0b2b4e9-90ca-4835-bdd4-2889ef5f926f","org_id":"2e7b6a08-b63b-4fc2-bd70-718091509db1","key":"hi","value":"1234"}
294+
{
295+
"success": true, "workflow_id": "99951014-f0b1-473d-a474-4dc9afedkb81", "execution_id": "f0b2b4e9-90ca-4835-bdd4-2889ef5ls2u5", "key": "hi", "value": "1234", "category": "category", "created": 1761114186, "edited": 1761114186, "changed": true, "encrypted": false, "public_authorization":"efbd9m2sy-f07c-4167-aa32-642b1429814d", "suborg_distribution": null, "revision_id": ""
296+
}
295297
```
296298

297299

0 commit comments

Comments
 (0)