Mercurial > p > roundup > code
view website/www/index.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 | e7293df727dc |
| children | b68d3d8531d5 29d428927362 |
line wrap: on
line source
Roundup Issue Tracker ===================== .. pypi-release:: roundup :prefix: Download :class: note Roundup is a simple-to-use and -install issue-tracking system with command-line, web and e-mail interfaces. It is based on the winning design from Ka-Ping Yee in the Software Carpentry "Track" design competition. The current stable version of Roundup is 1.6 which has quite a comprehensive :doc:`feature set <docs/features>`. For more information see the :doc:`design overview <docs/design>`, and all the other :doc:`documentation <docs>`. Roundup has been deployed for: * bug tracking and TODO list management (the classic installation) * customer help desk support (with a wizard for the phone answerers, linking to networking, system and development issue trackers) * issue management for IETF working groups * sales lead tracking * conference paper submission and double-blind referee management * weblogging (well, almost :) ...and so on. It's been designed with :doc:`flexibility <docs/customizing>` in mind - it's not just another bug tracker. Roundup ships with a *demo tracker* to play with - after you've unpacked the source, just run "python demo.py" and load up the URL it prints out! Roundup was originally released as version 0.1.1 in late August, 2001. The first `change note`_ I wrote says: Needed a bug tracking system. Looked around. Tried to install many Perl-based systems, to no avail. Got tired of waiting for Roundup to be released. Had just finished major product project, so needed something different for a while. Roundup here I come... .. _`download`: http://cheeseshop.python.org/pypi/roundup .. _`change note`: https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt