diff doc/features.txt @ 5695:3e1b66c4e1e2

Update docs. Correct errors reported by setup.py build_docs. Add rest interface and link to rest doc to features page. Add link to xmlrpc doc to features page. Add rest doc to index. Update rest doc, hopefully clarify confusing use of parameters in patch action section. Fix code examples in "Adding new rest endpoints" section. Fix example adding import of exception.
author John Rouillard <rouilj@ieee.org>
date Sun, 07 Apr 2019 20:17:52 -0400
parents df3f553fa414
children e48b039b0ec0
line wrap: on
line diff
--- a/doc/features.txt	Sat Apr 06 10:20:19 2019 -0400
+++ b/doc/features.txt	Sun Apr 07 20:17:52 2019 -0400
@@ -104,10 +104,17 @@
 
 *xmlrpc interface*
  - simple remote tracker interface with basic HTTP authentication
+   available at the /xmlrpc endpoint.
  - provides same access to tracker as roundup-admin, but based on
    XMLRPC calls
+ - see the `xmlrpc guide`_ for more details simple clients etc.
+
+*restful interface*
+ - accessible using basic HTTP authentication at /rest starting point
+ - see the `rest guide`_ for details.
 
 .. _sqlite: http://www.hwaci.com/sw/sqlite/
 .. _mysql: https://pypi.org/project/MySQL-python/
 .. _postgresql: http://initd.org/software/initd/psycopg
-
+.. _`xmlrpc guide`: xmlrpc.html
+.. _`rest guide`: rest.html

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