diff options
| author | Jakob L. Kreuze <zerodaysfordays@sdf.org> | 2020-06-14 19:07:39 -0400 |
|---|---|---|
| committer | Jakob L. Kreuze <zerodaysfordays@sdf.org> | 2020-06-14 19:07:39 -0400 |
| commit | e8020d1ec67c3f6e2e645ba80039d30db45950a9 (patch) | |
| tree | 50787657de987c1e0c3d39bac2b33cb958e6c3ed /README.md | |
| parent | 94d3fd454b8f70a430fc787357fdaccd7397e347 (diff) | |
Update semantics for web API (query string vs tag list).
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 9 |
1 files changed, 4 insertions, 5 deletions
@@ -85,13 +85,12 @@ Suppose we denote the following shape of JSON object as a `ImageResult`. ``` The images in the tag database can be enumerated with the 'posts' endpoint, -which takes two parameters: `tags`, a comma-separated list of zero or more -strings, and `last`, which is the last `ImageResult` identifier which was seen. -This endpoint will return, at most, 50 entries, which is why the `last` -parameter is necessary. +which takes two parameters: `query`, a query string, and `last`, which is the +last `ImageResult` identifier which was seen. This endpoint will return, at +most, 50 entries, which is why the `last` parameter is necessary. ``` -GET /api/posts?last=number,tags=[string, ...] +GET /api/posts?last=number,query=string [zero or more ImageResult] ``` |