annotate website/www/code.txt @ 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 c36ad0ba6aa3
children 45e8d10a9609
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:
diff changeset
1 Code
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
2 ====
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
3
5018
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
4 Project history is maintained in `CHANGES.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt>`_
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
5 file in code repository of Roundup, which can also be viewed online
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
6 through SourceForge `web interface <https://sourceforge.net/p/roundup/code/>`_.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
7
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
8 Get sources
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
9 -----------
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
10
5018
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
11 Official **read-only access** to Mercurial repository is provided through ::
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
12
5017
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
13 hg clone http://hg.code.sf.net/p/roundup/code roundup
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
14
5018
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
15 **Read/write access** requires SSH password or SSH key
7cfd30cc8cfa website: Reword code section, explain are why using SF and
anatoly techtonik <techtonik@gmail.com>
parents: 5017
diff changeset
16 authorization (see `SourceForge.net docs for details
4775
d00a3ede67e4 Changing www/code.txt towards new SF paths.
Bernhard Reiter <bernhard@intevation.de>
parents: 4596
diff changeset
17 <https://sourceforge.net/p/forge/documentation/Mercurial/>`_) ::
4552
68d647848ffc nicer formatting
Richard Jones <richard@users.sourceforge.net>
parents: 4549
diff changeset
18
5017
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
19 hg clone ssh://USERNAME@hg.code.sf.net/p/roundup/code roundup
4552
68d647848ffc nicer formatting
Richard Jones <richard@users.sourceforge.net>
parents: 4549
diff changeset
20
5017
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
21 You also need to be added as a Roundup developer for write access - ask
98344ba5e157 website: Update "getting code" documentation
anatoly techtonik <techtonik@gmail.com>
parents: 4829
diff changeset
22 for it on the :doc:`roundup-devel list <contact>`.
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
23
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
24 Run demo
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
25 --------
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
26
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
27 Roundup doesn't need any dependencies and works out of the box. Demo
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
28 is accessible at http://localhost:8917/demo/ by default ::
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
29
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
30 cd roundup
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
31 python demo.py
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
32
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
33 Execute tests
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
34 -------------
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
35 ::
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
36
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
37 python run_tests.py
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
38
5058
c36ad0ba6aa3 www: Fix link to README.txt
anatoly techtonik <techtonik@gmail.com>
parents: 5057
diff changeset
39 See repository `README.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/README.txt>`_
5057
d3efcaa0d6ff www: Extend code instructions with demo and test commands
anatoly techtonik <techtonik@gmail.com>
parents: 5032
diff changeset
40 for more info.

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