search

ckan / ckanapi

A command line interface and Python module for accessing the CKAN Action API
Other
176 stars 74 forks source link

Add expanded note/examples on ckanapi's ability to work with plugins that extend the CKAN Action API #182

Closed jqnatividad closed 3 years ago

jqnatividad commented 3 years ago

Right now, there's one sentence that's easy to gloss over in the README.

All actions in the CKAN Action API and actions added by CKAN plugins are supported by action shortcuts and call_action calls.

ckanapi works quite well with oft-used plugins like the Datastore, ckanext-harvest and ckanext-issues - all of which, extend the Action API.

$ ckanapi action datastore_info id=<RESOURCEID> -r https://myckan.example.com
$ ckanapi action harvest_log_list -r https://myckan.example.com
$ ckanapi action issue_report -r https://myckan.example.com

It would be nice if at least an illustrative example with the "built-in" Datastore plugin be included.

wardi commented 3 years ago

sounds like a good idea