http://localhost/ticket/336 <h2 id="Asa">As a</h2> <p> CKAN client such as ScraperWiki </p> <h2 id="Iwantto">I want to</h2> <p> search for Package Resources, either by URL or other field, or just get them all. I want to be able to get all the resource's fields, such as URL. </p> <h2 id="Proposedimplementation">Proposed implementation</h2> <p> Add resource search API at: </p> <p> /api/search/resource </p> <p> AND resource added to model API at: </p> <p> api/rest/resource </p> <p> Functional differences from the ScraperWiki suggested patch: </p> <ul><li>URL is not normalised </li></ul><p> </p> <ul><li>URLs are not grouped </li></ul><ul><li>All fields of the resource object are returned, not just the URL </li></ul><ul><li>Package is identified by its ID, not name or full URL. (This is for consistency in the API - you can simple prepend '<a class="ext-link" href="http://ckan.net/package/"><span class="icon">​</span>http://ckan.net/package/</a>' to the package ID) </li></ul><p> This is to make our API more general, simple and consistent. It means that the ScraperWiki client has to do a bit more processing to get exactly what it needs. Is this ok? </p> <h3 id="Examplesearch">Example search</h3> <p> POST </p> <pre class="wiki">{"url": "scraperwiki.com/", "all_fields": 1} </pre><p> to: /api/2/search/resource </p> <p> returns JSON: </p> <pre class="wiki"> [{"id": "a3dd8f64-9078-4f04-845c-e3f047125028", "package_id": "b8a325c8-af2a-43f3-8245-9db7d73dfbfe", "URL": "http://scraperwiki.com/lincolnshire-councillors", "format": "CSV", "Description": "Scrape of www.lincs.gov/councillors.pdf by ScraperWiki.", "hash": "", "position": 2 }] </pre><p> Note use of package_id instead of package_name is something we're moving towards in the API, since names can change. When we've done <a class="closed ticket" href="http://localhost/ticket/341" title="enhancement: Web UI accepts package IDs in URLs (closed: fixed)">ticket:341</a> then ckan.net/package/lincs-councillors will be a synonym of ckan.net/package/b8a325c8-af2a-43f3-8245-9db7d73dfbfe </p> <h3 id="Examplemodelrequest">Example model request</h3> <p> GET to: /api/2/rest/resource/a3dd8f64-9078-4f04-845c-e3f047125028 </p> <p> returns: </p> <pre class="wiki"> [{"id": "a3dd8f64-9078-4f04-845c-e3f047125028", "package_id": "b8a325c8-af2a-43f3-8245-9db7d73dfbfe", "URL": "http://scraperwiki.com/lincolnshire-councillors", "format": "CSV", "Description": "Scrape of www.lincs.gov/councillors.pdf by ScraperWiki.", "hash": "", "position": 2 }] </pre><h3 id="SearchParameters">Search Parameters</h3> <pre class="wiki">Key: q Description: Search all resource fields for the value Key: url / description / format / Description: Search particular field for the value Key: all_fields Value: 0 or 1 (0 is default) Description: If 1 (true), the full record of the package resource (and it's package reference) are returned, rather than just the PackageResource ID. </pre><p> May also choose to introduce 'offset' and 'limit' to page through a large number of results. </p> <p> JSONP achieved through API-wide parameter - see <a class="closed ticket" href="http://localhost/ticket/342" title="enhancement: JSONP parameter in API (closed: fixed)">ticket:342</a> </p> <p> Search is case insensitive. </p> <h2 id="Originalrequest">Original request</h2> <p> Hi, have attached a patch for adding a resource list api call. Have also added a JSONP compatible callback section, along the lines of <a class="closed ticket" href="http://localhost/ticket/388" title="task: Reply to &#34;two projects&#34; question from RS (closed: fixed)">#388</a>. </p> <p> Could also add a search version. Not sure what the best url would be for that though. </p> <p> Haven't written a test as the structure seems to follow a functional spec. Is that document around somewhere? </p> <p> Donovan </p> en-us http://assets.okfn.org/p/ckan/img/ckan_logo_shortname.png http://localhost/ticket/336 Trac 0.12.3 donovanhide Tue, 01 Jun 2010 17:02:58 GMT http://localhost/ticket/336 http://localhost/ticket/336 <ul> <li><strong>attachment</strong> set to <em>resource.patch</em> </li> </ul> Ticket dread Thu, 10 Jun 2010 09:36:41 GMT http://localhost/ticket/336#comment:1 http://localhost/ticket/336#comment:1 <ul> <li><strong>owner</strong> set to <em>dread</em> </li> <li><strong>description</strong> modified (<a href="/ticket/336?action=diff&amp;version=1">diff</a>) </li> </ul> Ticket dread Thu, 10 Jun 2010 09:37:10 GMT http://localhost/ticket/336#comment:2 http://localhost/ticket/336#comment:2 <ul> <li><strong>description</strong> modified (<a href="/ticket/336?action=diff&amp;version=2">diff</a>) </li> </ul> Ticket dread Thu, 10 Jun 2010 09:40:46 GMT http://localhost/ticket/336#comment:3 http://localhost/ticket/336#comment:3 <ul> <li><strong>description</strong> modified (<a href="/ticket/336?action=diff&amp;version=3">diff</a>) </li> </ul> Ticket dread Thu, 10 Jun 2010 09:56:57 GMT http://localhost/ticket/336#comment:4 http://localhost/ticket/336#comment:4 <ul> <li><strong>description</strong> modified (<a href="/ticket/336?action=diff&amp;version=4">diff</a>) </li> </ul> Ticket dread Thu, 10 Jun 2010 10:35:15 GMT http://localhost/ticket/336#comment:5 http://localhost/ticket/336#comment:5 <ul> <li><strong>description</strong> modified (<a href="/ticket/336?action=diff&amp;version=5">diff</a>) </li> </ul> Ticket dread Thu, 10 Jun 2010 10:40:37 GMT http://localhost/ticket/336#comment:6 http://localhost/ticket/336#comment:6 <ul> <li><strong>description</strong> modified (<a href="/ticket/336?action=diff&amp;version=6">diff</a>) </li> </ul> Ticket dread Thu, 10 Jun 2010 10:43:13 GMT http://localhost/ticket/336#comment:7 http://localhost/ticket/336#comment:7 <ul> <li><strong>description</strong> modified (<a href="/ticket/336?action=diff&amp;version=7">diff</a>) </li> </ul> Ticket dread Fri, 25 Jun 2010 16:28:10 GMT http://localhost/ticket/336#comment:8 http://localhost/ticket/336#comment:8 <ul> <li><strong>description</strong> modified (<a href="/ticket/336?action=diff&amp;version=8">diff</a>) </li> </ul> Ticket dread Mon, 28 Jun 2010 10:37:13 GMT http://localhost/ticket/336#comment:9 http://localhost/ticket/336#comment:9 <ul> <li><strong>summary</strong> changed from <em>Resource extension to REST API</em> to <em>Resource Search API</em> </li> </ul> Ticket dread Fri, 09 Jul 2010 18:27:01 GMT http://localhost/ticket/336#comment:10 http://localhost/ticket/336#comment:10 <ul> <li><strong>status</strong> changed from <em>new</em> to <em>closed</em> </li> <li><strong>resolution</strong> set to <em>fixed</em> </li> </ul> <p> Done in cset:742adebb707c and cset:1748e6554e77. </p> Ticket dread Fri, 09 Jul 2010 18:31:06 GMT http://localhost/ticket/336#comment:11 http://localhost/ticket/336#comment:11 <p> Took 0.75 days. </p> Ticket Donny Sat, 17 Jul 2010 12:09:04 GMT http://localhost/ticket/336#comment:12 http://localhost/ticket/336#comment:12 <ul> <li><strong>priority</strong> changed from <em>awaiting triage</em> to <em>blocker</em> </li> <li><strong>status</strong> changed from <em>closed</em> to <em>reopened</em> </li> <li><strong>resolution</strong> <em>fixed</em> deleted </li> <li><strong>type</strong> changed from <em>enhancement</em> to <em>defect</em> </li> </ul> <p> <a class="ext-link" href="http://ckan.net/api/search/resource?url=http://scraperwiki.com&amp;all_fields=1&amp;callback=ckantest"><span class="icon">​</span>http://ckan.net/api/search/resource?url=http://scraperwiki.com&amp;all_fields=1&amp;callback=ckantest</a> </p> <p> yields </p> <p> Bad search option: Field "callback" not recognised in Resource search. </p> Ticket dread Sat, 17 Jul 2010 13:37:22 GMT http://localhost/ticket/336#comment:13 http://localhost/ticket/336#comment:13 <ul> <li><strong>status</strong> changed from <em>reopened</em> to <em>closed</em> </li> <li><strong>resolution</strong> set to <em>fixed</em> </li> </ul> <p> Fixed in cset:e719f449bc74 </p> Ticket