Mercurial > p > roundup > code
view README.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 | bbfc87ecfdf1 |
| children | 49761be4a931 |
line wrap: on
line source
======================================================= Roundup: an Issue-Tracking System for Knowledge Workers ======================================================= INSTANT GRATIFICATION ===================== The impatient may try Roundup immediately by running demo.py from the source directory:: python demo.py This will create new tracker home in "demo" subdirectory and start server. To reset demo instance:: python demo.py nuke Tracker Home ============= "Tracker Home" is main concept when starting with Roundup. It is directory where all your tracker data is stored. This directory is created every time when new tracker is initialized and includes tracker configuration, database, template, schema and extensions. Installation ============ Please see "doc/installation.txt" Upgrading ========= Please see "doc/upgrading.txt" Usage and Other Information =========================== Start with the index.txt file in the "doc" directory. These documentation files are written in reStructedText, which can be converted into HTML format. If you have Sphinx installed, you can do this by running:: python setup.py build_doc Resulting HTML files will be in "share/doc/roundup/html" directory. For Developers ============== To get started on development work, read the developers.txt file in the "doc" directory. License ======= See COPYING.txt