17 Commits

Author	SHA1	Message	Date
Alan Orth	d1229c2387	Adjust docs at root ... Don't use a static HTML file anymore. Now I simply print an XHTML page from the Falcon resource. This way I can use variables to add in the API version as well as a link to the Swagger UI. The list of API calls is still present on the README.md, though in the long run I might move them to some dedicated documentation or a GitHub wiki.	2020-12-23 16:12:50 +02:00
Alan Orth	68418ea053	dspace_statistics_api/docs/openapi.json: Add /status ... Add a /status to the Swagger UI schema.	2020-12-22 11:41:47 +02:00
Alan Orth	6bbee7919e	Bump version to 1.4.0-dev	2020-12-22 11:31:46 +02:00
Alan Orth	a35ecf2394	Add Swagger UI on /swagger ... This includes a Swagger UI with an OpenAPI 3.0 JSON schema for easy interactive demonstration and testing of the API. The JSON schema was created with the standalone swagger-editor. Includes tests to make sure that the /swagger and /docs/openapi.json paths are acce- ssible.	2020-12-22 11:18:47 +02:00
Alan Orth	8a1244d2d0	Update changelog and docs	2020-12-20 16:45:49 +02:00
Alan Orth	930250352a	Update docs about POST /items	2020-12-13 20:09:20 +02:00
Alan Orth	3125e96a16	Bump version to 1.3.2	2020-11-18 22:01:18 +02:00
Alan Orth	2d6520fc97	Fix limit in docs	2020-11-02 22:14:08 +02:00
Alan Orth	549b8bf1a7	dspace_statistics_api/docs/index.html: Fix version ... We need to print it in the body, not the title.	2020-10-06 22:22:11 +03:00
Alan Orth	899a79b2e7	Version 1.3.1	2020-10-06 22:15:52 +03:00
Alan Orth	4e9064329d	Bump version to 1.3.0	2020-10-06 21:33:38 +03:00
Alan Orth	a0ee181361	dspace_statistics_api/docs/index.html: Fix whitespace	2020-09-25 13:33:45 +03:00
Alan Orth	2201d3df4e	dspace_statistics_api/docs/index.html: Minor HTML syntax issue	2020-09-25 12:55:39 +03:00
Alan Orth	2c0436f845	Update API docs HTML for /items POST functionality	2020-09-25 12:53:30 +03:00
Alan Orth	998e833470	dspace_statistics_api/docs/index.html: Adjust help text	2020-03-02 14:30:16 +02:00
Alan Orth	eb08832bf8	Sync API documentation HTML with README.md	2018-11-01 00:37:52 +02:00
Alan Orth	30dc7f1939	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-11-01 00:19:39 +02:00