diff --git a/ckan/templates/_snippet/data-api-help.html b/ckan/templates/_snippet/data-api-help.html index 5a499c938b8..bab65b21550 100644 --- a/ckan/templates/_snippet/data-api-help.html +++ b/ckan/templates/_snippet/data-api-help.html @@ -15,102 +15,51 @@

-

Access resource data via a web API with powerful query - support. Further information in the main - CKAN Data API and DataStore documentation.

+

Access (and update) resource data via a web API with powerful query + support.

+ +
- Endpoints » -
-
-
-

The Data API builds directly on ElasticSearch, with a resource API - endpoint being equivalent to a single index 'type' in ElasticSearch. - This means you can directly re-use ElasticSearch - client libraries when connecting to the API endpoint.

- - - - - - - - - - - - - - - - -
Query example - ${datastore_api}/_search?size=5&pretty=true -
Schema (Mapping) - ${datastore_api}/_mapping?pretty=true -
Base${datastore_api}
-
-
-
- -
-
- Querying - » + Example URLs and Endpoints»
-
+
-

Basic queries can be done using the q - parameter in the query string which supports the Lucene - query parser syntax and hence filters on specific fields - (e.g. fieldname:value), wildcards (e.g. abc*) - and more. Full query parameters and options in the ElasticSearch - URI request docs.

+ Query example (first 5 results) +

+ ${datastore_api}/_search?size=5&pretty=true +

+ + Query example (results with 'jones' in title field) +

+ ${datastore_api}/_search?q=title:jones&size=5&pretty=true +

-

More complex queries, including those that involve - faceting and statistical operations, should use the full ElasticSearch - query language in which the query is a JSON structure sent in the - ?source= parameter. See ElasticSearch - query documentation.

+ Schema (Mapping) +

+ ${datastore_api}/_mapping?pretty=true +

-

JSONP support is available via a simple callback query parameter: - ?callback=my_callback_name.

+ Endpoint (for clients) +

+ ${datastore_api} +

-
-
- Example: cURL (or Browser) » -
-
-
-

The following examples utilize the cURL - command line utility. If you prefer, you you can just open the relevant urls in - your browser.

- - 
-// added pretty=true to get the json results pretty printed
-curl ${datastore_api}/_search?q=title:jones&size=5&pretty=true
-
-
-
Example: Javascript
-
+

A simple ajax (JSONP) request to the data API using jQuery.

@@ -119,7 +68,8 @@ 

   q: 'title:jones' // query on the title field for 'jones'
 };
 $.ajax({
-  url: ${datastore_api}/_search,
+  url: '${datastore_api}/_search',
+  data: data,
   dataType: 'jsonp',
   success: function(data) {
     alert('Total results found: ' + data.hits.total)
@@ -128,6 +78,22 @@
+ +
+
+ Example: Python +
+
+
+ 
+import urllib
+url = '${datastore_api}/_search?size=5&q=title:jones'
+fileobj = urllib.urlopen(url)
+print fileobj.read()
+
+
+
+
diff --git a/doc/using-data-api.rst b/doc/using-data-api.rst index 09c26b1f075..3c6a6fe82cf 100644 --- a/doc/using-data-api.rst +++ b/doc/using-data-api.rst @@ -10,8 +10,7 @@ being equivalent to a single index 'type' in ElasticSearch (we tend to refer to it as a 'table'). This means you can often directly re-use `ElasticSearch client libraries`_ when connecting to the API endpoint. -Furthermore, it means that almost all of what is presented below is generally -applicable to ElasticSearch. +Furthermore, it means that what is presented below is essentially a tutorial in the ElasticSearch API. .. _ElasticSearch client libraries: http://www.elasticsearch.org/guide/appendix/clients.html