view website/www/contents.txt @ 5632:a29a8dae2095

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.
author John Rouillard <rouilj@ieee.org>
date Fri, 01 Mar 2019 23:24:40 -0500
parents da2decb6d0c7
children fefd8263ee4d
line wrap: on
line source

.. Roundup documentation master file, created by sphinx-quickstart on Tue Jan 20 17:33:20 2009.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Sitemap
=======

Contents:

.. toctree::
   :maxdepth: 2

   Home <index>
   Download <http://pypi.python.org/pypi/roundup>
   docs
   Issues <https://issues.roundup-tracker.org>
   contact
   Wiki <http://wiki.roundup-tracker.org>
   code

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


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