Initial implementation of function to return data for / and /data endpoints under /rest/. /rest/ returns: 1) default_version of the interface and supported_version array 2) list of links with rel and uri properties that indicate what assets are available under /rest. E.g. /rest/data /data returns: a list of possible assets (e.g. issue, user, keyword, status) and links for accessing those assets. E.G. { "data": { "keyword": { "link": "https://example.net/demo/rest/data/keyword" }, "user": { "link": "https://example.net/demo/rest/data/user" }, ... } } Both of these are currently hand coded. Others will be doing more development on the rest interface. These two examples are meant to spark discussion on what the payloads returned by the rest interface should look like and give some ideas around HATEOAS.

================
Roundup Glossary
================


class
   a definition of the properties and behaviour of a set of items
db (or hyperdb)
   a collection of items
designator
   a combined class + itemid reference to any item in the hyperdb
itemid
   a numeric reference to a particular item of one class
item
   a collection of data that forms one entry in the hyperdb.
property
   one element of data that makes up an item. In Roundup, the set 
   of item properties may be changed as needed - even after the 
   tracker has been initialised and used in production.
schema
   the definition of all the classes that make up an tracker
tracker
   the schema and hyperdb that forms one issue tracker
tracker home
   the physical location on disk of a tracker


-----------------

Back to `Table of Contents`_

.. _`Table of Contents`: index.html