alanorth/dspace-statistics-api
1
0
Fork 0
mirror of https://github.com/ilri/dspace-statistics-api.git synced 2024-11-22 14:25:01 +01:00
Code Releases Activity

README.md: Add API documentation endpoint

Browse Source
This commit is contained in:
Alan Orth 2018-11-01 00:22:16 +02:00
parent 30dc7f1939
commit 0d4be5f4c8
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -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