Skip to content

Commit c8682d5

Browse files
authored
Added category API updates
1 parent 4e8fb43 commit c8682d5

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

docs/API.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -577,6 +577,8 @@ Datastore is a persistent storage mechanism you can use for workflows to talk to
577577
### Add a key
578578
To add or edit a cache key use
579579

580+
To add a key to a specific category, add `"category": "name"` to the JSON body.
581+
580582
Methods: POST, PUT
581583

582584
```
@@ -592,6 +594,8 @@ curl https://shuffler.io/api/v1/orgs/{org_id}/set_cache -H "Authorization: Beare
592594
### Get a key
593595
Search for a cache key. For keys set in a workflow, it may unavailable with the normal API, and require execution_id & authorization in the JSON body.
594596

597+
To get a key from a specific category, add `"category": "name"` to the JSON body.
598+
595599
Methods: POST
596600

597601
```
@@ -606,7 +610,14 @@ curl https://shuffler.io/api/v1/orgs/{org_id}/get_cache -H "Authorization: Beare
606610

607611

608612
### List all keys
609-
List existing datastore (cache) keys
613+
List existing datastore (cache) keys. By default, this will include the 50 last modified keys from any category.
614+
615+
To list keys from a specific category, ?category=<name> to the URL.
616+
617+
Available queries:
618+
- top: default 50. How many keys to return.
619+
- cursor: to get the next page
620+
- category: the category to get
610621

611622
Methods: GET
612623

@@ -621,13 +632,14 @@ curl https://shuffler.io/api/v1/orgs/{org_id}/list_cache -H "Authorization: Bear
621632
```
622633

623634
### Delete a key
624-
Deletes a key, completely removing all references to it
635+
Deletes a key, completely removing all references to it.
636+
637+
To delete a key from a specific category, add `"category": "name"` to the JSON body.
625638

626639
Methods: DELETE
627640

628641
```
629-
curl -XDELETE https://shuffler.io/api/v1/orgs/{org_id}/cache/{cache_key} -H "Authorization: Bearer APIKEY"
630-
642+
curl https://shuffler.io/api/v1/orgs/{org_id}/delete_cache -H "Authorization: Bearer APIKEY" -d '{"org_id": "ORG_ID", "key": "hi"}'
631643
```
632644

633645

0 commit comments

Comments
 (0)