CKAN: Ticket #2330: Make api read-actions GETable

milestone changed

icmurray — Tue, 01 May 2012 14:04:41 GMT

milestone changed from ckan-sprint-2012-04-30 to current-ckan-sprint-2012-05-15

priority changed

icmurray — Tue, 01 May 2012 14:07:58 GMT

priority changed from awaiting triage to major

icmurray — Fri, 04 May 2012 16:39:31 GMT

Implemented, providing two methods of passing an action's parameters. Either, each parameter is specified as a url parameter, eg

curl http://127.0.0.1:5000/api/3/action/package_search?q=police

or, for cases where a more complex data_dict is required, the data_dict can be parsed as a json-encoded dict in a single url-parameter called data_dict, ie:

curl http://127.0.0.1:5000/api/3/action/package_search?data_dict={'q':'police'}

As part of this ticket:

I noticed that all module-public members of the action modules were being loaded as actions (including functions imported from other modules). So I've cleared up the action modules to prevent this.

I've cleaned up the action modules to use get_or_bust() when accessing a passed in data_dict outside before it's been validated by a schema. This provides better error messages for clients.

provided a decorator, @side_effect_free, for users implementing their own actions through the IActions interface to be able to expose their custom/overridden actions as a GET request through the action API.

icmurray — Mon, 07 May 2012 10:42:08 GMT

Replying to icmurray:

or, for cases where a more complex data_dict is required, the data_dict can be parsed as a json-encoded dict in a single url-parameter called data_dict, ie:
curl http://127.0.0.1:5000/api/3/action/package_search?data_dict={'q':'police'}

Another option is to have the data_dict json-encoded in the GET request's body. This is possible, but

1) Although permissable, it's not, as I understand it, conventional to have a GET request's body form the options of the request.

2) Caching proxies won't inspect the body of the request, only the URL.

status changed; resolution set

icmurray — Tue, 15 May 2012 09:15:14 GMT

status changed from new to closed
resolution set to fixed