From dd8252601fea0f812d059f92f8771d87335a44f7 Mon Sep 17 00:00:00 2001 From: Alan Orth Date: Mon, 2 Mar 2020 14:29:13 +0200 Subject: [PATCH] README.md: Adjust API help text --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f873d4..762fc63 100644 --- a/README.md +++ b/README.md @@ -81,9 +81,9 @@ The API exposes the following endpoints: - GET `/` — return a basic API documentation page. - GET `/items` — return views and downloads for all items that Solr knows about¹. Accepts `limit` and `page` query parameters for pagination of results (`limit` must be an integer between 1 and 100, and `page` must be an integer greater than or equal to 0). - - GET `/item/id` — return views and downloads for a single item (`id` must be a positive integer). Returns HTTP 404 if an item id is not found. + - GET `/item/id` — return views and downloads for a single item (`id` must be a UUID). Returns HTTP 404 if an item id is not found. -The item id is the *internal* id for an item. You can get these from the standard DSpace REST API. +The item id is the *internal* uuid for an item. You can get these from the standard DSpace REST API. ¹ We are querying the Solr statistics core, which technically only knows about items that have either views or downloads. If an item is not present here you can assume it has zero views and zero downloads, but not necessarily that it does not exist in the repository.