annotate website/www/Makefile @ 5639:f576957cbb1f

Add support for prev/next/self links when returning paginated results. To do this: 1) change "data" envelope from an array to a dict 2) move the "data" array to the "collection" property, which is an array of elements in the collection. 3) add @links dict keyed by link relation: self, next, prev. Each relation is an array of dicts with uri and rel keys. In this case there is only one element, but there is nothing preventing a relation from having multiple url's. So this follows the formatting needed for the general case. Relations are present only if it makes sense. So first page has no prev and last page has no next. 4) add @total_size with number of element selected if they were not paginated. Replicates data in X-Count-Total header. Changed index to start at 1. So the first page is page_index 1 and not page_index 0. (So I am no longer surprised when I set page_index to 1 and am missing a bunch of records 8-)). Also a small fixup, json response ends with a newline so printing the data, or using curl makes sure that anything printing after the json output (like shell prompts) is on a new line. Tests added for all cases.
author John Rouillard <rouilj@ieee.org>
date Sat, 09 Mar 2019 11:06:10 -0500
parents 8e34362a14f7
children 977e0ef08406
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
1 TMP := _tmp
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
2 HTML := html
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
3
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
4 .PHONY: help clean html linkcheck
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
5
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
6 help:
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
7 @echo "Please use \`make <target>' where <target> is one of"
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
8 @echo " html to make standalone HTML files"
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
9 @echo " linkcheck to check all external links for integrity"
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
10
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
11 clean:
4703
8e34362a14f7 issue2550774: Fix generating the website documentation
John Kristensen <john@jerrykan.com>
parents: 4609
diff changeset
12 -rm -rf $(TMP) $(HTML) docs COPYING.txt
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
13
4609
9ed905019303 website docs: Added link to Makefile and adapted the hg command needed for sf.
Bernhard Reiter <bernhard@intevation.de>
parents: 4553
diff changeset
14 docs:
9ed905019303 website docs: Added link to Makefile and adapted the hg command needed for sf.
Bernhard Reiter <bernhard@intevation.de>
parents: 4553
diff changeset
15 ln -s ../../doc ./docs
4703
8e34362a14f7 issue2550774: Fix generating the website documentation
John Kristensen <john@jerrykan.com>
parents: 4609
diff changeset
16 ln -s ../../COPYING.txt
4609
9ed905019303 website docs: Added link to Makefile and adapted the hg command needed for sf.
Bernhard Reiter <bernhard@intevation.de>
parents: 4553
diff changeset
17
9ed905019303 website docs: Added link to Makefile and adapted the hg command needed for sf.
Bernhard Reiter <bernhard@intevation.de>
parents: 4553
diff changeset
18 html: docs
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
19 mkdir -p $(TMP)/doctrees $(HTML)
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
20 sphinx-build -b html -d $(TMP)/doctrees . $(HTML)
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
21
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
22 linkcheck:
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
23 mkdir -p $(TMP)/linkcheck $(TMP)/doctrees
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
24 sphinx-build -b linkcheck -d $(TMP)/doctrees . $(TMP)/linkcheck
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
25 @echo
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
26 @echo "Link check complete; look for any errors in the above output " \
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
27 "or in .build/linkcheck/output.txt."

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