Updated docs and Readme

Author: Nick-S-2018

README.md

@@ -1,13 +1,11 @@
 # manticoresearch
-Low-level client for Manticore Search.
+Сlient for Manticore Search.
 
 
 
 ## Requirements.
 
-Python 2.7 and 3.4+.
-
-Minimum Manticore Search version is > 2.5.1 with HTTP protocol enabled.
+Minimum Manticore Search version is >= 2.5.1 with HTTP protocol enabled.
 
 | Manticore Search  | manticoresearch-python   |     Python    |
 | ----------------- | ------------------------ | ------------- |
@@ -82,7 +80,7 @@ with manticoresearch.ApiClient(configuration) as api_client:
 # Documentation
 
 
-Full documentation is available in  [docs](https://github.com/manticoresoftware/manticoresearch-python/tree/master/docs) folder.
+Full documentation on the API Endpoints and Models used is available in  [docs](https://github.com/manticoresoftware/manticoresearch-python/tree/master/docs) folder as listed below.
 
 Manticore Search server documentation: https://manual.manticoresearch.com.
 
@@ -98,7 +96,7 @@ Class | Method | HTTP request | Description
 *IndexApi* | [**replace**](docs/IndexApi.md#replace) | **POST** /replace | Replace new document in an index
 *IndexApi* | [**update**](docs/IndexApi.md#update) | **POST** /update | Update a document in an index
 *SearchApi* | [**percolate**](docs/SearchApi.md#percolate) | **POST** /pq/{index}/search | Perform reverse search on a percolate index
-*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Performs a search
+*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Performs a search on an index
 *UtilsApi* | [**sql**](docs/UtilsApi.md#sql) | **POST** /sql | Perform SQL requests
 
 

docs/SearchApi.md

@@ -4,22 +4,22 @@ All URIs are relative to *http://127.0.0.1:9308*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**search**](SearchApi.md#search) | **POST** /search | Performs search
-[**percolate**](SearchApi.md#percolate) | **POST** /pq/{index}/search | Perform reverse search on a percolate index
+[**search**](SearchApi.md#search) | **POST** /search | Performs a search on an index.
+[**percolate**](SearchApi.md#percolate) | **POST** /pq/{index}/search | Perform a reverse search on a percolate index
 
 
 ## **search**
 > SearchResponse search(search_request)
 
-Performs search
+Performs a search on an index. 
 
-
-Expects an object with mandatory properties:
-* the index name
+The method expects an object with the following mandatory properties:
+        
+* the name of the index to search
+        
 * the match query object
 
-Example:
-
+Here is an example search request:
   ```
   {
     'index':'movies',
@@ -48,13 +48,20 @@ Example:
 
 Alternatively, you can use auxiliary objects to build your search query. For details, see the documentation on [**SearchRequest**](SearchRequest.md)
 
-It responds with an object with:
-- an array with hits (matched documents) found
-- if the query is timed out
-- time of execution
-- if profiling is enabled, an additional array with profiling information attached
+The method returns an object with the following properties:
+        
+- took: the time taken to execute the search query.
+- timed_out: a boolean indicating whether the query timed out.
+- hits: an object with the following properties:
+  - total: the total number of hits found.
+  - hits: an array of hit objects, where each hit object represents a matched document. Each hit object has the following properties:
+    - _id: the ID of the matched document.
+    - _score: the score of the matched document.
+    - _source: the source data of the matched document.
 
+In addition, if profiling is enabled, the response will include an additional array with profiling information attached.
 
+Here is an example search response:
   ```
   {
     'took':10,
@@ -150,13 +157,13 @@ No authorization required
 ## **percolate**
 > SearchResponse percolate(index,percolate_request)
 
-Perform reverse search on a percolate index
+Perform a reverse search on a percolate index
 
 Performs a percolate search. 
 This method must be used only on percolate indexes.
 
-Expects two parameters: the index name and an object with array of documents to be tested.
-An example of the documents object:
+Expects two parameters: the index name and an object with an array of documents to search with.
+Here is an example of the document object:
 
   ```
   {

docs/SearchRequest.md

@@ -76,6 +76,7 @@ Name | Type | Description | Notes
 
     api_response = api_instance.search(search_req)
     pprint(api_response)
+```
 
 ### Sort
 ```python
@@ -89,9 +90,11 @@ Name | Type | Description | Notes
 ```
 
 ### SortOrder
-### SortMVA
 
 [[SortOrder - input parameters]](SortOrder.md)
+
+### SortMVA
+
 [[SortMVA - input parameters]](SortMVA.md)
 
 [[Docs on sorting in Manticore Search Manual]](https://manual.manticoresearch.com/Searching/Sorting_and_ranking#HTTP)
@@ -190,7 +193,7 @@ Name | Type | Description | Notes
 
 [[QueryFilter - input parameters]](QueryFilter.md)
 ```python    
-	#Using a QueryFilter object
+    #Using a QueryFilter object
     search_req.fulltext_filter = manticoresearch.model.QueryFilter('test')
 
     api_response = api_instance.search(search_req)
@@ -227,7 +230,7 @@ Name | Type | Description | Notes
 
 [[MatchOpFilter - input parameters]](MatchOpFilter.md)
 ```python    
-	#Using a MatchOpFilter object
+    #Using a MatchOpFilter object
     search_req.fulltext_filter = manticoresearch.model.MatchOpFilter('test1 test2', 'title', 'and')
 
     api_response = api_instance.search(search_req)

manticoresearch/__init__.py

@@ -5,9 +5,9 @@
 """
     Manticore Search Client
 
-    Low-level client for Manticore Search.   # noqa: E501
+    Сlient for Manticore Search.   # noqa: E501
 
-    The version of the OpenAPI document: 1.0.0
+    The version of the OpenAPI document: 3.3.0
     Contact: [email protected]
     Generated by: https://openapi-generator.tech
 """

manticoresearch/api/search_api.py

@@ -184,9 +184,9 @@ def percolate_with_http_info(self, index, percolate_request, **kwargs):  # noqa:
 
 
     def search(self, search_request, **kwargs):  # noqa: E501
-        """Performs a search  # noqa: E501
+        """Performs a search on an index  # noqa: E501
 
-         Expects an object with mandatory properties: * the index name * the match query object Example :    ```   {     'index':'movies',     'query':     {       'bool':       {         'must':[{'query_string':' movie'}]       }     },     'script_fields':     {       'myexpr':       {         'script':{'inline':'IF(rating>8,1,0)'       }     },     'sort':     [       {'myexpr':'desc'},       {'_score':'desc'}     ],     'profile':true   }   ```  Alternatively, you can use auxiliary objects to build your search query. For details, see the documentation on [**SearchRequest**](SearchRequest.md)  It responds with an object with: - an array with hits (matched documents) found - if the query is timed out - time of execution - if profiling is enabled, an additional array with profiling information attached     ```   {     'took':10,     'timed_out':false,     'hits':     {       'total':2,       'hits':       [         {'_id':'1','_score':1,'_source':{'gid':11}},         {'_id':'2','_score':1,'_source':{'gid':12}}       ]     }   }   ```  For more information about the match query syntax and additional parameters that can be added to request and response, please check: https://manual.manticoresearch.com/Searching/Full_text_matching/Basic_usage#HTTP-JSON.   # noqa: E501
+         The method expects an object with the following mandatory properties: * the name of the index to search * the match query object Here is an example search request:    ```   {     'index':'movies',     'query':     {       'bool':       {         'must':[{'query_string':' movie'}]       }     },     'script_fields':     {       'myexpr':       {         'script':{'inline':'IF(rating>8,1,0)'       }     },     'sort':     [       {'myexpr':'desc'},       {'_score':'desc'}     ],     'profile':true   }   ```  Alternatively, you can use auxiliary objects to build your search query. For details, see the documentation on [**SearchRequest**](SearchRequest.md)  The method returns an object with the following properties: - took: the time taken to execute the search query. - timed_out: a boolean indicating whether the query timed out. - hits: an object with the following properties:    - total: the total number of hits found.    - hits: an array of hit objects, where each hit object represents a matched document. Each hit object has the following properties:      - _id: the ID of the matched document.      - _score: the score of the matched document.      - _source: the source data of the matched document.  In addition, if profiling is enabled, the response will include an additional array with profiling information attached. Here is an example search response:    ```   {     'took':10,     'timed_out':false,     'hits':     {       'total':2,       'hits':       [         {'_id':'1','_score':1,'_source':{'gid':11}},         {'_id':'2','_score':1,'_source':{'gid':12}}       ]     }   }   ```  For more information about the match query syntax and additional parameters that can be added to request and response, please see the documentation [here](https://manual.manticoresearch.com/Searching/Full_text_matching/Basic_usage#HTTP-JSON).   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -214,9 +214,9 @@ def search(self, search_request, **kwargs):  # noqa: E501
         return self.search_with_http_info(search_request, **kwargs)  # noqa: E501
 
     def search_with_http_info(self, search_request, **kwargs):  # noqa: E501
-        """Performs a search  # noqa: E501
+        """Performs a search on an index  # noqa: E501
 
-         Expects an object with mandatory properties: * the index name * the match query object Example :    ```   {     'index':'movies',     'query':     {       'bool':       {         'must':[{'query_string':' movie'}]       }     },     'script_fields':     {       'myexpr':       {         'script':{'inline':'IF(rating>8,1,0)'       }     },     'sort':     [       {'myexpr':'desc'},       {'_score':'desc'}     ],     'profile':true   }   ```  Alternatively, you can use auxiliary objects to build your search query. For details, see the documentation on [**SearchRequest**](SearchRequest.md)  It responds with an object with: - an array with hits (matched documents) found - if the query is timed out - time of execution - if profiling is enabled, an additional array with profiling information attached     ```   {     'took':10,     'timed_out':false,     'hits':     {       'total':2,       'hits':       [         {'_id':'1','_score':1,'_source':{'gid':11}},         {'_id':'2','_score':1,'_source':{'gid':12}}       ]     }   }   ```  For more information about the match query syntax and additional parameters that can be added to request and response, please check: https://manual.manticoresearch.com/Searching/Full_text_matching/Basic_usage#HTTP-JSON.   # noqa: E501
+         The method expects an object with the following mandatory properties: * the name of the index to search * the match query object Here is an example search request:    ```   {     'index':'movies',     'query':     {       'bool':       {         'must':[{'query_string':' movie'}]       }     },     'script_fields':     {       'myexpr':       {         'script':{'inline':'IF(rating>8,1,0)'       }     },     'sort':     [       {'myexpr':'desc'},       {'_score':'desc'}     ],     'profile':true   }   ```  Alternatively, you can use auxiliary objects to build your search query. For details, see the documentation on [**SearchRequest**](SearchRequest.md)  The method returns an object with the following properties: - took: the time taken to execute the search query. - timed_out: a boolean indicating whether the query timed out. - hits: an object with the following properties:    - total: the total number of hits found.    - hits: an array of hit objects, where each hit object represents a matched document. Each hit object has the following properties:      - _id: the ID of the matched document.      - _score: the score of the matched document.      - _source: the source data of the matched document.  In addition, if profiling is enabled, the response will include an additional array with profiling information attached. Here is an example search response:    ```   {     'took':10,     'timed_out':false,     'hits':     {       'total':2,       'hits':       [         {'_id':'1','_score':1,'_source':{'gid':11}},         {'_id':'2','_score':1,'_source':{'gid':12}}       ]     }   }   ```  For more information about the match query syntax and additional parameters that can be added to request and response, please see the documentation [here](https://manual.manticoresearch.com/Searching/Full_text_matching/Basic_usage#HTTP-JSON).   # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

manticoresearch/configuration.py

@@ -371,7 +371,7 @@ def to_debug_report(self):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 1.0.0\n"\
+               "Version of the API: 3.3.0\n"\
                "SDK Package Version: 3.3.0".\
                format(env=sys.platform, pyversion=sys.version)
 

manticoresearch/model/__init__.py

@@ -4,9 +4,9 @@
 """
     Manticore Search Client
 
-    Low-level client for Manticore Search.   # noqa: E501
+    Сlient for Manticore Search.   # noqa: E501
 
-    The version of the OpenAPI document: 1.0.0
+    The version of the OpenAPI document: 3.3.0
     Contact: [email protected]
     Generated by: https://openapi-generator.tech
 """

manticoresearch/model_utils.py

@@ -1,9 +1,9 @@
 """
     Manticore Search Client
 
-    Low-level client for Manticore Search.   # noqa: E501
+    Сlient for Manticore Search.   # noqa: E501
 
-    The version of the OpenAPI document: 1.0.0
+    The version of the OpenAPI document: 3.3.0
     Contact: [email protected]
     Generated by: https://openapi-generator.tech
 """