annotate website/www/make.bat @ 5632:a29a8dae2095

Initial implementation of function to return data for / and /data endpoints under /rest/. /rest/ returns: 1) default_version of the interface and supported_version array 2) list of links with rel and uri properties that indicate what assets are available under /rest. E.g. /rest/data /data returns: a list of possible assets (e.g. issue, user, keyword, status) and links for accessing those assets. E.G. { "data": { "keyword": { "link": "https://example.net/demo/rest/data/keyword" }, "user": { "link": "https://example.net/demo/rest/data/user" }, ... } } Both of these are currently hand coded. Others will be doing more development on the rest interface. These two examples are meant to spark discussion on what the payloads returned by the rest interface should look like and give some ideas around HATEOAS.
author John Rouillard <rouilj@ieee.org>
date Fri, 01 Mar 2019 23:24:40 -0500
parents bcec10953ae8
children 3a851df879cd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5016
bcec10953ae8 website: Use path-independent way of Sphinx evoking
anatoly techtonik <techtonik@gmail.com>
parents: 4820
diff changeset
1 @rem python -m pip install sphinx
bcec10953ae8 website: Use path-independent way of Sphinx evoking
anatoly techtonik <techtonik@gmail.com>
parents: 4820
diff changeset
2 @rem python -m pip install sphinxcontrib-cheeseshop
bcec10953ae8 website: Use path-independent way of Sphinx evoking
anatoly techtonik <techtonik@gmail.com>
parents: 4820
diff changeset
3
bcec10953ae8 website: Use path-independent way of Sphinx evoking
anatoly techtonik <techtonik@gmail.com>
parents: 4820
diff changeset
4 python -m sphinx . html

Roundup Issue Tracker: http://roundup-tracker.org/