ckan/ckan — pull request #1318 by amercader (2014-11-28 18:15:23+00:00)
Title: CKAN API - remove help string from standard calls

The current API behavior is to include the full help string for a route with every API call. In most cases, the person or app making that request does not need the help string. This, in effect, unnecessarily increases the size of the request responses.

I propose that API route behavior is modified to only include the help string 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 27 times larger than the result string.

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