Skip to content

Commit 14d6c73

Browse files
Nick-S-2018Nick-S-2018
committed
Updated documentation
1 parent 723cea2 commit 14d6c73

19 files changed

+397
-464
lines changed

‎README.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
Low-level client for Manticore Search.
33

44

5-
❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-python/tree/3.3.0
65

76
## Requirements.
87

@@ -93,13 +92,13 @@ All URIs are relative to *http://127.0.0.1:9308*
9392

9493
Class | Method | HTTP request | Description
9594
------------ | ------------- | ------------- | -------------
96-
*IndexApi* | [**bulk**](docs/IndexApi.md#bulk) | **POST** /json/bulk | Bulk index operations
97-
*IndexApi* | [**delete**](docs/IndexApi.md#delete) | **POST** /json/delete | Delete a document in an index
98-
*IndexApi* | [**insert**](docs/IndexApi.md#insert) | **POST** /json/insert | Create a new document in an index
99-
*IndexApi* | [**replace**](docs/IndexApi.md#replace) | **POST** /json/replace | Replace new document in an index
100-
*IndexApi* | [**update**](docs/IndexApi.md#update) | **POST** /json/update | Update a document in an index
101-
*SearchApi* | [**percolate**](docs/SearchApi.md#percolate) | **POST** /json/pq/{index}/search | Perform reverse search on a percolate index
102-
*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /json/search | Performs a search
95+
*IndexApi* | [**bulk**](docs/IndexApi.md#bulk) | **POST** /bulk | Bulk index operations
96+
*IndexApi* | [**delete**](docs/IndexApi.md#delete) | **POST** /delete | Delete a document in an index
97+
*IndexApi* | [**insert**](docs/IndexApi.md#insert) | **POST** /insert | Create a new document in an index
98+
*IndexApi* | [**replace**](docs/IndexApi.md#replace) | **POST** /replace | Replace new document in an index
99+
*IndexApi* | [**update**](docs/IndexApi.md#update) | **POST** /update | Update a document in an index
100+
*SearchApi* | [**percolate**](docs/SearchApi.md#percolate) | **POST** /pq/{index}/search | Perform reverse search on a percolate index
101+
*SearchApi* | [**search**](docs/SearchApi.md#search) | **POST** /search | Performs a search
103102
*UtilsApi* | [**sql**](docs/UtilsApi.md#sql) | **POST** /sql | Perform SQL requests
104103

105104

‎docs/BoolFilter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**must** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional]
99
**must_not** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | [optional]
1010

11-
[[Using in search requests]](SearchApi.md#BoolFilter)
11+
[[Using in search requests]](SearchRequest.md#BoolFilter)
1212

1313
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1414

‎docs/EqualsFilter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**field** | **str** | |
88
**value** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | |
99

10-
[[Using in search requests]](SearchApi.md#EqualsFilter)
10+
[[Using in search requests]](SearchRequest.md#EqualsFilter)
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

‎docs/GeoDistanceFilter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**distance_type** | **str** | | [optional]
1010
**distance** | **str** | | [optional]
1111

12-
[[Using in search requests]](SearchApi.md#GeoDistanceFilter)
12+
[[Using in search requests]](SearchRequest.md#GeoDistanceFilter)
1313

1414
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1515

‎docs/HighlightField.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**limit_words** | **int** | | [optional] [default to 0]
1010
**limit_snippets** | **int** | | [optional] [default to 0]
1111

12-
[[Using in search requests]](SearchApi.md#HighlightField)
12+
[[Using in search requests]](SearchRequest.md#HighlightField)
1313

1414
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1515

‎docs/InFilter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**field** | **str** | |
88
**values** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | |
99

10-
[[Using in search requests]](SearchApi.md#InFilter)
10+
[[Using in search requests]](SearchRequest.md#InFilter)
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

‎docs/IndexApi.md‎

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ All URIs are relative to *http://127.0.0.1:9308*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**bulk**](IndexApi.md#bulk) | **POST** /json/bulk | Bulk index operations
8-
[**delete**](IndexApi.md#delete) | **POST** /json/delete | Delete a document in an index
9-
[**insert**](IndexApi.md#insert) | **POST** /json/insert | Create a new document in an index
10-
[**replace**](IndexApi.md#replace) | **POST** /json/replace | Replace new document in an index
11-
[**update**](IndexApi.md#update) | **POST** /json/update | Update a document in an index
7+
[**bulk**](IndexApi.md#bulk) | **POST** /bulk | Bulk index operations
8+
[**delete**](IndexApi.md#delete) | **POST** /delete | Delete a document in an index
9+
[**insert**](IndexApi.md#insert) | **POST** /insert | Create a new document in an index
10+
[**replace**](IndexApi.md#replace) | **POST** /replace | Replace new document in an index
11+
[**update**](IndexApi.md#update) | **POST** /update | Update a document in an index
1212

1313

14-
# **bulk**
14+
## **bulk**
1515
> BulkResponse bulk(body)
1616
1717
Bulk index operations
@@ -83,7 +83,6 @@ with manticoresearch.ApiClient(configuration) as api_client:
8383

8484
```
8585

86-
8786
### Parameters
8887

8988
Name | Type | Description | Notes
@@ -111,7 +110,7 @@ No authorization required
111110

112111
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
113112

114-
# **delete**
113+
## **delete**
115114
> DeleteResponse delete(delete_document_request)
116115
117116
Delete a document in an index
@@ -190,7 +189,6 @@ with manticoresearch.ApiClient(configuration) as api_client:
190189

191190
```
192191

193-
194192
### Parameters
195193

196194
Name | Type | Description | Notes
@@ -218,7 +216,7 @@ No authorization required
218216

219217
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
220218

221-
# **insert**
219+
## **insert**
222220
> SuccessResponse insert(insert_document_request)
223221
224222
Create a new document in an index
@@ -312,7 +310,6 @@ with manticoresearch.ApiClient(configuration) as api_client:
312310

313311
```
314312

315-
316313
### Parameters
317314

318315
Name | Type | Description | Notes
@@ -340,7 +337,7 @@ No authorization required
340337

341338
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
342339

343-
# **replace**
340+
## **replace**
344341
> SuccessResponse replace(insert_document_request)
345342
346343
Replace new document in an index
@@ -393,7 +390,6 @@ with manticoresearch.ApiClient(configuration) as api_client:
393390

394391
```
395392

396-
397393
### Parameters
398394

399395
Name | Type | Description | Notes
@@ -421,7 +417,7 @@ No authorization required
421417

422418
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
423419

424-
# **update**
420+
## **update**
425421
> UpdateResponse update(update_document_request)
426422
427423
Update a document in an index
@@ -500,7 +496,6 @@ with manticoresearch.ApiClient(configuration) as api_client:
500496

501497
```
502498

503-
504499
### Parameters
505500

506501
Name | Type | Description | Notes

‎docs/MatchFilter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**query_string** | **str** | | [default to ""]
88
**query_fields** | **str** | | [default to "*"]
99

10-
[[Using in search requests]](SearchApi.md#MatchFilter)
10+
[[Using in search requests]](SearchRequest.md#MatchFilter)
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

‎docs/MatchOpFilter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**query_fields** | **str** | |
99
**operator** | **str** | |
1010

11-
[[Using in search requests]](SearchApi.md#MatchOpFilter)
11+
[[Using in search requests]](SearchRequest.md#MatchOpFilter)
1212

1313
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1414

‎docs/MatchPhraseFilter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**query_phrase** | **str** | |
88
**query_fields** | **str** | |
99

10-
[[Using in search requests]](SearchApi.md#MatchPhraseFilter)
10+
[[Using in search requests]](SearchRequest.md#MatchPhraseFilter)
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

0 commit comments

Comments
 (0)