From 0d4be5f4c8f75d041e0fa488fff114df44ef5f8a Mon Sep 17 00:00:00 2001 From: Alan Orth Date: Thu, 1 Nov 2018 00:22:16 +0200 Subject: [PATCH] README.md: Add API documentation endpoint --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b7c688..077e7f3 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,7 @@ This would expose the API at `/rest/statistics`. ## Using the API 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. - 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. @@ -68,7 +69,6 @@ The API exposes the following endpoints: ## Todo -- Add API documentation - Close DB connection when gunicorn shuts down gracefully - Better logging - Tests