While working on a prototype on a HTML5 mobile and desktop application
I've hit a few limitations of the REST APIs.
This is why I propose some enhancements to the current REST APIs to
give more flexibility, particularly:
Support for start and order parameter in queries returning large
list of pages
Support order parameter in page list
Adding page version, author information and data information when missing
Hidden documents filter activation or deactivation in REST APIs
Adding pretty display of title and author names
Support queries using XWQL, HQL and Lucene
The rendered content should be accessible from REST apis
The details of the proposal is here:
http://dev.xwiki.org/xwiki/bin/view/Design/RESTApiImprovements
A pull request for a prototype implementation of these requirements is
available here:
https://github.com/xwiki/xwiki-platform/pull/56/files#r1040052
Not everything has an implementation (hidden docs and rendered content
is not implemented yet). Other are not implementing according to this
specification as some comments have already been made.
Particularly the following votes are required:
VOTE to accept supporting "start" and "order" parameters only on
queries having only one unique scope
VOTE in search queries for just adding the descendent date order or
add more order possibilities using order and orderdir param
VOTE in page list queries for just adding the descendent date order or
add more order possibilities using order and orderdir param
VOTE to add page version and author fields to page and other resources
VOTE for adding the additional fields with or without a parameter
"pagedetails=1"
VOTE for adding a parameter to show/hide hidden documents independent
of user setting
VOTE to add the displayTitle field with or without the pagedetails=1
parameter or with it's own parameter displayTitle=1
VOTE to add the author display names with or without the
displayPrettyNames parameter
VOTE for supporting the searchQuery API at the wiki level with multi
wiki support at the lucene level
VOTE for adding rendered content using the withrenderedcontent=1 param
VOTE for having absolute URLs in the rendered content using
withabsoluteurls=1 param
Thanks
Ludovic
--
Ludovic Dubost
Founder and CEO
Blog:
http://blog.ludovic.org/
XWiki:
http://www.xwiki.com
Skype: ldubost GTalk: ldubost