[ckan-dev] API Suggestion - verbosity of help strings

Fri Nov 8 15:52:40 UTC 2013

It is awesome to have the API baked into CKAN.  It has a lot of power, but could also be tweaked a little bit.

One suggestion that I have is to only pass the help string in the result when the route is called with no params, or potentially when a 'help param' is passed in the request.

Help is good when you need it, but it just bloats the result object when you don't need it.  In this example, the amount of string associated with help is more than 10 times larger than the result string.

http://demo.ckan.org/api/action/package_search?q=lidar

There may be a good reason for all of this, but I offer it for consideration.  If you think that it is worth recording, I can file a ticket.

David.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.okfn.org/pipermail/ckan-dev/attachments/20131108/171488f7/attachment.html>