diff --git a/docs/api.rst b/docs/api.rst index 5a75608a..839cc5cb 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,3 +1,5 @@ +.. _api: + API Documentation ================= diff --git a/docs/helpers.rst b/docs/helpers.rst index d6909853..f85d0685 100644 --- a/docs/helpers.rst +++ b/docs/helpers.rst @@ -1,3 +1,5 @@ +.. _helpers: + Helpers ======= diff --git a/docs/index.rst b/docs/index.rst index b8b6adab..598017af 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -51,6 +51,11 @@ Example Usage Features -------- +This client was designed as very thin wrapper around Elasticseach's REST API to +allow for maximum flexibility. This means that there are no opinions in this +client; it also means that some of the APIs are a little cumbersome to use from +Python. We have created some :ref:`helpers` to help with this issue. + Extendability ~~~~~~~~~~~~~ diff --git a/elasticsearch/helpers.py b/elasticsearch/helpers.py index 95f36e9b..1772533b 100644 --- a/elasticsearch/helpers.py +++ b/elasticsearch/helpers.py @@ -12,7 +12,8 @@ def bulk_index(client, docs, chunk_size=500, stats_only=False, **kwargs): { '_index': 'index-name', '_type': 'document', - '_parent': '5', + '_id': 42, + '_parent': 5, '_ttl': '1d', '_source': { ...