From 209a07e6080cfd7cdbcdab093848c10a6385cb1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Honza=20Kr=C3=A1l?= Date: Fri, 17 Jan 2014 14:56:35 +0100 Subject: [PATCH] Update documentation links for existing APIs --- elasticsearch/client/__init__.py | 34 ++++++++++++++++---------------- elasticsearch/client/cluster.py | 6 +++--- elasticsearch/client/indices.py | 6 +++--- 3 files changed, 23 insertions(+), 23 deletions(-) diff --git a/elasticsearch/client/__init__.py b/elasticsearch/client/__init__.py index 7e32ae8e..2a4314bb 100644 --- a/elasticsearch/client/__init__.py +++ b/elasticsearch/client/__init__.py @@ -123,7 +123,7 @@ class Elasticsearch(object): """ Adds a typed JSON document in a specific index, making it searchable. Behind the scenes this method calls index(..., op_type='create') - ``_ + ``_ :arg index: The name of the index :arg doc_type: The type of the document @@ -149,7 +149,7 @@ class Elasticsearch(object): def index(self, index, doc_type, body, id=None, params=None): """ Adds or updates a typed JSON document in a specific index, making it searchable. - ``_ + ``_ :arg index: The name of the index :arg doc_type: The type of the document @@ -176,7 +176,7 @@ class Elasticsearch(object): def exists(self, index, id, doc_type='_all', params=None): """ Returns a boolean indicating whether or not given document exists in Elasticsearch. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -202,7 +202,7 @@ class Elasticsearch(object): def get(self, index, id, doc_type='_all', params=None): """ Get a typed JSON document from the index based on its id. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -233,7 +233,7 @@ class Elasticsearch(object): def get_source(self, index, id, doc_type='_all', params=None): """ Get the source of a document by it's index, type and id. - ``_ + ``_ :arg index: The name of the index :arg doc_type: The type of the document (uses `_all` by default to @@ -260,7 +260,7 @@ class Elasticsearch(object): def mget(self, body, index=None, doc_type=None, params=None): """ Get multiple documents based on an index, type (optional) and ids. - ``_ + ``_ :arg body: Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. @@ -291,7 +291,7 @@ class Elasticsearch(object): def update(self, index, doc_type, id, body=None, params=None): """ Update a document based on a script or partial data provided. - ``_ + ``_ :arg index: The name of the index :arg doc_type: The type of the document @@ -329,7 +329,7 @@ class Elasticsearch(object): def search(self, index=None, doc_type=None, body=None, params=None): """ Execute a search query and get back search hits that match the query. - ``_ + ``_ :arg index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -397,7 +397,7 @@ class Elasticsearch(object): The explain api computes a score explanation for a query and a specific document. This can give useful feedback whether a document matches or didn't match a specific query. - ``_ + ``_ :arg index: The name of the index :arg doc_type: The type of the document @@ -435,7 +435,7 @@ class Elasticsearch(object): def scroll(self, scroll_id, params=None): """ Scroll a search request created by specifying the scroll parameter. - ``_ + ``_ :arg scroll_id: The scroll ID :arg scroll: Specify how long a consistent view of the index should be @@ -464,7 +464,7 @@ class Elasticsearch(object): def delete(self, index, doc_type, id, params=None): """ Delete a typed JSON document from a specific index based on its id. - ``_ + ``_ :arg index: The name of the index :arg doc_type: The type of the document @@ -485,7 +485,7 @@ class Elasticsearch(object): def count(self, index=None, doc_type=None, body=None, params=None): """ Execute a query and get the number of matches for that query. - ``_ + ``_ :arg index: A comma-separated list of indices to restrict the results :arg doc_type: A comma-separated list of types to restrict the results @@ -531,7 +531,7 @@ class Elasticsearch(object): def msearch(self, body, index=None, doc_type=None, params=None): """ Execute several search requests within the same API. - ``_ + ``_ :arg body: The request definitions (metadata-search request definition pairs), as either a newline separated string, or a sequence of @@ -548,7 +548,7 @@ class Elasticsearch(object): def delete_by_query(self, index, doc_type=None, body=None, params=None): """ Delete documents from one or more indices and one or more types based on a query. - ``_ + ``_ :arg index: A comma-separated list of indices to restrict the operation :arg doc_type: A comma-separated list of types to restrict the operation @@ -571,7 +571,7 @@ class Elasticsearch(object): """ The suggest feature suggests similar looking terms based on a provided text by using a suggester. - ``_ + ``_ :arg index: A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices @@ -592,7 +592,7 @@ class Elasticsearch(object): """ Send a percolate request which include a doc, and get back the queries that match on that doc out of the set of registered queries. - ``_ + ``_ :arg index: The name of the index with a registered percolator query :arg doc_type: The document type @@ -613,7 +613,7 @@ class Elasticsearch(object): def mlt(self, index, doc_type, id, body=None, params=None): """ Get documents that are "like" a specified document. - ``_ + ``_ :arg index: The name of the index :arg doc_type: The type of the document (use `_all` to fetch the first diff --git a/elasticsearch/client/cluster.py b/elasticsearch/client/cluster.py index 32560723..5c3c779d 100644 --- a/elasticsearch/client/cluster.py +++ b/elasticsearch/client/cluster.py @@ -41,7 +41,7 @@ class ClusterClient(NamespacedClient): def state(self, params=None): """ Get a comprehensive state information of the whole cluster. - ``_ + ``_ :arg filter_blocks: Do not return information about blocks :arg filter_index_templates: Do not return information about index templates @@ -61,7 +61,7 @@ class ClusterClient(NamespacedClient): def reroute(self, body=None, params=None): """ Explicitly execute a cluster reroute allocation command including specific commands. - ``_ + ``_ :arg body: The definition of `commands` to perform (`move`, `cancel`, `allocate`) :arg dry_run: Simulate the operation only and return the resulting state @@ -87,7 +87,7 @@ class ClusterClient(NamespacedClient): def put_settings(self, body, params=None): """ Update cluster wide specific settings. - ``_ + ``_ :arg body: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). diff --git a/elasticsearch/client/indices.py b/elasticsearch/client/indices.py index f3da6a11..14e58bc1 100644 --- a/elasticsearch/client/indices.py +++ b/elasticsearch/client/indices.py @@ -526,7 +526,7 @@ class IndicesClient(NamespacedClient): def stats(self, index=None, metric_family=None, params=None): """ Retrieve statistics on different operations happening on an index. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -573,7 +573,7 @@ class IndicesClient(NamespacedClient): def segments(self, index=None, params=None): """ Provide low level segments information that a Lucene index (shard level) is built with. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -632,7 +632,7 @@ class IndicesClient(NamespacedClient): def validate_query(self, index=None, doc_type=None, body=None, params=None): """ Validate a potentially expensive query without executing it. - ``_ + ``_ :arg index: A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices