From 1e7fba8ace59a92173a09f92f3e3aa8125de0ef7 Mon Sep 17 00:00:00 2001 From: Clementine Urquizar Date: Mon, 7 Dec 2020 19:03:16 +0100 Subject: [PATCH] Update error comments --- meilisearch/client.py | 22 ++++++------ meilisearch/index.py | 82 +++++++++++++++++++++---------------------- 2 files changed, 52 insertions(+), 52 deletions(-) diff --git a/meilisearch/client.py b/meilisearch/client.py index d97e2384..8343ed76 100644 --- a/meilisearch/client.py +++ b/meilisearch/client.py @@ -44,7 +44,7 @@ def create_index(self, uid, options=None): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return Index.create(self.config, uid, options) @@ -59,7 +59,7 @@ def get_indexes(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get(self.config.paths.index) @@ -80,7 +80,7 @@ def get_index(self, uid): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return Index(self.config, uid).fetch_info() @@ -120,7 +120,7 @@ def get_or_create_index(self, uid, options=None): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ try: index_instance = self.get_index(uid) @@ -144,7 +144,7 @@ def get_all_stats(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get(self.config.paths.stat) @@ -156,7 +156,7 @@ def health(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get(self.config.paths.health) @@ -174,7 +174,7 @@ def get_keys(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get(self.config.paths.keys) @@ -189,7 +189,7 @@ def get_version(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get(self.config.paths.version) @@ -204,7 +204,7 @@ def version(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.get_version() @@ -220,7 +220,7 @@ def create_dump(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post(self.config.paths.dumps) @@ -241,7 +241,7 @@ def get_dump_status(self, uid): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( self.config.paths.dumps + '/' + str(uid) + '/status' diff --git a/meilisearch/index.py b/meilisearch/index.py index 1346c346..c25a788e 100644 --- a/meilisearch/index.py +++ b/meilisearch/index.py @@ -39,7 +39,7 @@ def delete(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete('{}/{}'.format(self.config.paths.index, self.uid)) @@ -60,7 +60,7 @@ def update(self, **body): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ payload = {} primary_key = body.get('primaryKey', None) @@ -81,7 +81,7 @@ def fetch_info(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ index_dict = self.http.get('{}/{}'.format(self.config.paths.index, self.uid)) self.primary_key = index_dict['primaryKey'] @@ -98,7 +98,7 @@ def get_primary_key(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.fetch_info().primary_key @@ -121,7 +121,7 @@ def create(cls, config, uid, options=None): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ if options is None: options = {} @@ -140,7 +140,7 @@ def get_all_update_status(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( '{}/{}/{}'.format( @@ -166,7 +166,7 @@ def get_update_status(self, update_id): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( '{}/{}/{}/{}'.format( @@ -197,7 +197,7 @@ def wait_for_pending_update(self, update_id, timeout_in_ms=5000, interval_in_ms= Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ start_time = datetime.now() elapsed_time = 0 @@ -224,7 +224,7 @@ def get_stats(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( '{}/{}/{}'.format( @@ -253,7 +253,7 @@ def search(self, query, opt_params=None): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ if opt_params is None: opt_params = {} @@ -285,7 +285,7 @@ def get_document(self, document_id): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( '{}/{}/{}/{}'.format( @@ -312,7 +312,7 @@ def get_documents(self, parameters=None): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ if parameters is None: parameters = {} @@ -344,7 +344,7 @@ def add_documents(self, documents, primary_key=None): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ if primary_key is None: url = '{}/{}/{}'.format( @@ -380,7 +380,7 @@ def update_documents(self, documents, primary_key=None): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ if primary_key is None: url = '{}/{}/{}'.format( @@ -415,7 +415,7 @@ def delete_document(self, document_id): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( '{}/{}/{}/{}'.format( @@ -443,7 +443,7 @@ def delete_documents(self, ids): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post( '{}/{}/{}/delete-batch'.format( @@ -466,7 +466,7 @@ def delete_all_documents(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( '{}/{}/{}'.format( @@ -492,7 +492,7 @@ def get_settings(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( '{}/{}/{}'.format( @@ -523,7 +523,7 @@ def update_settings(self, body): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post( '{}/{}/{}'.format( @@ -548,7 +548,7 @@ def reset_settings(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( '{}/{}/{}'.format( @@ -572,7 +572,7 @@ def get_ranking_rules(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( self.__settings_url_for(self.config.paths.ranking_rules) @@ -596,7 +596,7 @@ def update_ranking_rules(self, body): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post( self.__settings_url_for(self.config.paths.ranking_rules), @@ -615,7 +615,7 @@ def reset_ranking_rules(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( self.__settings_url_for(self.config.paths.ranking_rules), @@ -636,7 +636,7 @@ def get_distinct_attribute(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( self.__settings_url_for(self.config.paths.distinct_attribute) @@ -660,7 +660,7 @@ def update_distinct_attribute(self, body): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post( self.__settings_url_for(self.config.paths.distinct_attribute), @@ -679,7 +679,7 @@ def reset_distinct_attribute(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( self.__settings_url_for(self.config.paths.distinct_attribute), @@ -699,7 +699,7 @@ def get_searchable_attributes(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( self.__settings_url_for(self.config.paths.searchable_attributes) @@ -723,7 +723,7 @@ def update_searchable_attributes(self, body): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post( self.__settings_url_for(self.config.paths.searchable_attributes), @@ -742,7 +742,7 @@ def reset_searchable_attributes(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( self.__settings_url_for(self.config.paths.searchable_attributes), @@ -762,7 +762,7 @@ def get_displayed_attributes(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( self.__settings_url_for(self.config.paths.displayed_attributes) @@ -786,7 +786,7 @@ def update_displayed_attributes(self, body): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post( self.__settings_url_for(self.config.paths.displayed_attributes), @@ -805,7 +805,7 @@ def reset_displayed_attributes(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( self.__settings_url_for(self.config.paths.displayed_attributes), @@ -825,7 +825,7 @@ def get_stop_words(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( self.__settings_url_for(self.config.paths.stop_words) @@ -849,7 +849,7 @@ def update_stop_words(self, body): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post( self.__settings_url_for(self.config.paths.stop_words), @@ -868,7 +868,7 @@ def reset_stop_words(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( self.__settings_url_for(self.config.paths.stop_words), @@ -888,7 +888,7 @@ def get_synonyms(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( self.__settings_url_for(self.config.paths.synonyms) @@ -912,7 +912,7 @@ def update_synonyms(self, body): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post( self.__settings_url_for(self.config.paths.synonyms), @@ -931,7 +931,7 @@ def reset_synonyms(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( self.__settings_url_for(self.config.paths.synonyms), @@ -951,7 +951,7 @@ def get_attributes_for_faceting(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.get( self.__settings_url_for(self.config.paths.attributes_for_faceting) @@ -975,7 +975,7 @@ def update_attributes_for_faceting(self, body): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.post( self.__settings_url_for(self.config.paths.attributes_for_faceting), @@ -994,7 +994,7 @@ def reset_attributes_for_faceting(self): Raises ------ MeiliSearchApiError - In case of any HTTP code error described here https://docs.meilisearch.com/references/#errors-status-code + An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors """ return self.http.delete( self.__settings_url_for(self.config.paths.attributes_for_faceting),