view doc/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 487dc55e3c5e
children 3e1b66c4e1e2
line wrap: on
line source

=======================================================
Roundup: an Issue-Tracking System for Knowledge Workers
=======================================================

For how to contact the community see http://www.roundup-tracker.org .

Contents
========

.. toctree::
   :maxdepth: 2

   features
   installation
   upgrading
   FAQ
   user_guide
   customizing
   admin_guide
   debugging
   xmlrpc
   overview
   Design (original) <design>
   developers
   tracker_templates
   Notes about the MySQL Database backend <mysql>
   Notes about the PostgreSQL Database backend <postgresql>
   glossary
   acknowledgements
   Richard Jones implementation notes <implementation>
   license

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