dspace-statistics-api/dspace_statistics_api/docs/index.html

<!DOCTYPE html>
<html lang="en-US">
    <head>
        <meta charset="UTF-8">
        <title>DSpace Statistics API</title>
    </head>
    <body>
        <h1>DSpace Statistics API</h1>
        <p>This site is running the <a href="https://github.com/ilri/dspace-statistics-api" title="DSpace Statistics API project">DSpace Statistics API</a>. The following endpoints are available:</p>
        <ul>
            <li>GET <code>/</code> — return a basic API documentation page.</li>
            <li>GET <code>/items</code> — return views and downloads for all items that Solr knows about¹. Accepts <code>limit</code> and <code>page</code> query parameters for pagination of results (<code>limit</code> must be an integer between 1 and 100, and <code>page</code> must be an integer greater than or equal to 0).</li>
            <li>GET <code>/item/id</code> — return views and downloads for a single item (<code>id</code> must be a positive integer). Returns HTTP 404 if an item id is not found.</li>
        </ul>

        <p>The item id is the <em>internal</em> id for an item. You can get these from the standard DSpace REST API.</p>

        <p>¹ 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.</code>
    </body>
</html>
-												Add basic API documentation on root (/)

I had imagined plugging in an interactive Swagger or OpenAPI instance
here, but that's actually much more involved in Falcon than I want to
deal with right now.

											
										
										
											2018-10-31 23:19:39 +01:00
+								<!DOCTYPE html>
 								<html lang="en-US">
 								    <head>
 								        <meta charset="UTF-8">
 								        <title>DSpace Statistics API</title>
 								    </head>
 								    <body>
 								        <h1>DSpace Statistics API</h1>
 								        <p>This site is running the <a href="https://github.com/ilri/dspace-statistics-api" title="DSpace Statistics API project">DSpace Statistics API</a>. The following endpoints are available:</p>
 								        <ul>
 								            <li>GET <code>/</code> — return a basic API documentation page.</li>
-												Sync API documentation HTML with README.md

											
										
										
											2018-10-31 23:37:52 +01:00
+								            <li>GET <code>/items</code> — return views and downloads for all items that Solr knows about¹. Accepts <code>limit</code> and <code>page</code> query parameters for pagination of results (<code>limit</code> must be an integer between 1 and 100, and <code>page</code> must be an integer greater than or equal to 0).</li>
-												Add basic API documentation on root (/)

I had imagined plugging in an interactive Swagger or OpenAPI instance
here, but that's actually much more involved in Falcon than I want to
deal with right now.

											
										
										
											2018-10-31 23:19:39 +01:00
+								            <li>GET <code>/item/id</code> — return views and downloads for a single item (<code>id</code> must be a positive integer). Returns HTTP 404 if an item id is not found.</li>
 								        </ul>
-												Sync API documentation HTML with README.md

											
										
										
											2018-10-31 23:37:52 +01:00
 								        <p>The item id is the <em>internal</em> id for an item. You can get these from the standard DSpace REST API.</p>
 								        <p>¹ 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.</code>
-												Add basic API documentation on root (/)

I had imagined plugging in an interactive Swagger or OpenAPI instance
here, but that's actually much more involved in Falcon than I want to
deal with right now.

											
										
										
											2018-10-31 23:19:39 +01:00
+								    </body>
 								</html>