Updated docs and changelog example

Nick-S-2018 · Nick-S-2018 · commit 63932800f45a · 2024-10-11T19:27:04.000+07:00
diff --git a/CHANGELOG_EXAMPLE.md b/CHANGELOG_EXAMPLE.md
@@ -6,27 +6,27 @@ This release includes:
 
 - updated sql request and error response formats to match changes in Manticore
 
-- BREAKING CHANGES: updated the structure of client classes to strictly match the request/response formats specified by Manticore's HTTP API 
+- BREAKING CHANGES: updated the structure of client classes to strictly match the request/response formats specified by Manticore's JSON API 
   (Related Github issue: https://github.com/manticoresoftware/openapi/issues/16)
 
   - added classes:
-    - [[AggCompositeSource]](./docs/AggCompositeSource.md)
+    - [AggCompositeSource](./docs/AggCompositeSource.md)
       More on aggregation: https://manual.manticoresearch.com/dev/Searching/Grouping#GROUP-BY-multiple-fields-at-once
-    - [[AggCompositeTerm]](./docs/AggCompositeTerm.md)
+    - [AggCompositeTerm](./docs/AggCompositeTerm.md)
       More on aggregation: https://manual.manticoresearch.com/dev/Searching/Grouping#GROUP-BY-multiple-fields-at-once
-    - [[HighlightFieldOption]](./docs/HighlightFieldOption.md)
+    - [HighlightFieldOption](./docs/HighlightFieldOption.md)
       More on highlighting: https://manual.manticoresearch.com/dev/Searching/Highlighting#Highlighting-via-HTTP
-    - [[Join]](./docs/Join.md)
+    - [Join](./docs/Join.md)
       More on joining tables: https://manual.manticoresearch.com/dev/Searching/Joining#Joining-tables
-    - [[JoinOn]](./docs/JoinOn.md)
+    - [JoinOn](./docs/JoinOn.md)
       More on joining tables: https://manual.manticoresearch.com/dev/Searching/Joining#Joining-tables
-    - [[JoinCond]](./docs/JoinCond.md)
+    - [JoinCond](./docs/JoinCond.md)
       More on joining tables: https://manual.manticoresearch.com/dev/Searching/Joining#Joining-tables
-    - [[KnnQuery]](./docs/KnnQuery.md)
+    - [KnnQuery](./docs/KnnQuery.md)
       More on KNN search: https://manual.manticoresearch.com/dev/Searching/KNN#KNN-vector-search
-    - [[ResponseErrorDetails]](./docs/ResponseErrorDetails.md)
-    - [[ResponseError]](./docs/ResponseError.md)
-    - [[SearchQuery]](./docs/SearchQuery.md)
+    - [ResponseErrorDetails](./docs/ResponseErrorDetails.md)
+    - [ResponseError](./docs/ResponseError.md)
+    - [SearchQuery](./docs/SearchQuery.md)
       More on searching: https://manual.manticoresearch.com/dev/Searching/Intro#General-syntax    
   
   - removed classes:
@@ -57,13 +57,13 @@ This release includes:
     - SourceMultiple
     
   - renamed classes:
-    - AggregationTerms -> [[AggTerms]](./docs/AggTerms.md)
+    - AggregationTerms -> [AggTerms](./docs/AggTerms.md)
       More on aggregation: https://manual.manticoresearch.com/dev/Searching/Grouping#GROUP-BY-multiple-fields-at-once
-    - GeoDistanceFilterLocationAnchor -> [[GeoDistanceLocationAnchor]](./docs/GeoDistanceLocationAnchor.md)
+    - GeoDistanceFilterLocationAnchor -> [GeoDistanceLocationAnchor](./docs/GeoDistanceLocationAnchor.md)
       More on geo filtering: https://manual.manticoresearch.com/dev/Searching/Filters#location_anchor
-    - GeoDistanceFilter -> [[GeoDistance]](./docs/GeoDistance.md)
+    - GeoDistanceFilter -> [GeoDistance](./docs/GeoDistance.md)
       More on geo filtering: https://manual.manticoresearch.com/dev/Searching/Filters#Geo-distance-filters
-    - SourceByRules -> [[SourceRules]](./docs/SourceRules.md)
+    - SourceByRules -> [SourceRules](./docs/SourceRules.md)
       More on the 'source' property:
       https://manual.manticoresearch.com/dev/Searching/Search_results#Source-selection
 
diff --git a/docs/AggComposite.md b/docs/AggComposite.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.agg_composite import AggComposite
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of AggComposite from a JSON string
 agg_composite_instance = AggComposite.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/AggCompositeSource.md b/docs/AggCompositeSource.md
@@ -13,8 +13,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.agg_composite_source import AggCompositeSource
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of AggCompositeSource from a JSON string
 agg_composite_source_instance = AggCompositeSource.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/AggCompositeTerm.md b/docs/AggCompositeTerm.md
@@ -13,8 +13,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.agg_composite_term import AggCompositeTerm
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of AggCompositeTerm from a JSON string
 agg_composite_term_instance = AggCompositeTerm.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/AggTerms.md b/docs/AggTerms.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.agg_terms import AggTerms
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of AggTerms from a JSON string
 agg_terms_instance = AggTerms.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/Aggregation.md b/docs/Aggregation.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.aggregation import Aggregation
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of Aggregation from a JSON string
 aggregation_instance = Aggregation.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/BoolFilter.md b/docs/BoolFilter.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.bool_filter import BoolFilter
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of BoolFilter from a JSON string
 bool_filter_instance = BoolFilter.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/BulkResponse.md b/docs/BulkResponse.md
@@ -15,8 +15,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.bulk_response import BulkResponse
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of BulkResponse from a JSON string
 bulk_response_instance = BulkResponse.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/DeleteDocumentRequest.md b/docs/DeleteDocumentRequest.md
@@ -16,8 +16,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.delete_document_request import DeleteDocumentRequest
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of DeleteDocumentRequest from a JSON string
 delete_document_request_instance = DeleteDocumentRequest.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/DeleteResponse.md b/docs/DeleteResponse.md
@@ -17,8 +17,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.delete_response import DeleteResponse
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of DeleteResponse from a JSON string
 delete_response_instance = DeleteResponse.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/ErrorResponse.md b/docs/ErrorResponse.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.error_response import ErrorResponse
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of ErrorResponse from a JSON string
 error_response_instance = ErrorResponse.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/FulltextFilter.md b/docs/FulltextFilter.md
@@ -16,8 +16,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.fulltext_filter import FulltextFilter
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of FulltextFilter from a JSON string
 fulltext_filter_instance = FulltextFilter.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/GeoDistance.md b/docs/GeoDistance.md
@@ -16,8 +16,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.geo_distance import GeoDistance
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of GeoDistance from a JSON string
 geo_distance_instance = GeoDistance.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/GeoDistanceLocationAnchor.md b/docs/GeoDistanceLocationAnchor.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.geo_distance_location_anchor import GeoDistanceLocationAnchor
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of GeoDistanceLocationAnchor from a JSON string
 geo_distance_location_anchor_instance = GeoDistanceLocationAnchor.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/Highlight.md b/docs/Highlight.md
@@ -34,8 +34,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.highlight import Highlight
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of Highlight from a JSON string
 highlight_instance = Highlight.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/HighlightFieldOption.md b/docs/HighlightFieldOption.md
@@ -17,8 +17,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.highlight_field_option import HighlightFieldOption
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of HighlightFieldOption from a JSON string
 highlight_field_option_instance = HighlightFieldOption.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/IndexApi.md b/docs/IndexApi.md
diff --git a/docs/InsertDocumentRequest.md b/docs/InsertDocumentRequest.md
@@ -16,8 +16,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.insert_document_request import InsertDocumentRequest
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of InsertDocumentRequest from a JSON string
 insert_document_request_instance = InsertDocumentRequest.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/Join.md b/docs/Join.md
@@ -15,8 +15,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.join import Join
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of Join from a JSON string
 join_instance = Join.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/JoinCond.md b/docs/JoinCond.md
@@ -15,8 +15,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.join_cond import JoinCond
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of JoinCond from a JSON string
 join_cond_instance = JoinCond.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/JoinOn.md b/docs/JoinOn.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.join_on import JoinOn
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of JoinOn from a JSON string
 join_on_instance = JoinOn.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/KnnQuery.md b/docs/KnnQuery.md
@@ -18,8 +18,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.knn_query import KnnQuery
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of KnnQuery from a JSON string
 knn_query_instance = KnnQuery.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/PercolateRequest.md b/docs/PercolateRequest.md
@@ -13,8 +13,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.percolate_request import PercolateRequest
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of PercolateRequest from a JSON string
 percolate_request_instance = PercolateRequest.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/PercolateRequestQuery.md b/docs/PercolateRequestQuery.md
@@ -12,8 +12,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.percolate_request_query import PercolateRequestQuery
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of PercolateRequestQuery from a JSON string
 percolate_request_query_instance = PercolateRequestQuery.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/QueryFilter.md b/docs/QueryFilter.md
@@ -21,8 +21,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.query_filter import QueryFilter
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of QueryFilter from a JSON string
 query_filter_instance = QueryFilter.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/ReplaceDocumentRequest.md b/docs/ReplaceDocumentRequest.md
@@ -13,8 +13,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.replace_document_request import ReplaceDocumentRequest
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of ReplaceDocumentRequest from a JSON string
 replace_document_request_instance = ReplaceDocumentRequest.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/ResponseError.md b/docs/ResponseError.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.response_error import ResponseError
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of ResponseError from a JSON string
 response_error_instance = ResponseError.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/ResponseErrorDetails.md b/docs/ResponseErrorDetails.md
@@ -15,8 +15,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.response_error_details import ResponseErrorDetails
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of ResponseErrorDetails from a JSON string
 response_error_details_instance = ResponseErrorDetails.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/SearchApi.md b/docs/SearchApi.md
diff --git a/docs/SearchQuery.md b/docs/SearchQuery.md
@@ -22,8 +22,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.search_query import SearchQuery
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of SearchQuery from a JSON string
 search_query_instance = SearchQuery.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/SearchRequest.md b/docs/SearchRequest.md
@@ -27,8 +27,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.search_request import SearchRequest
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of SearchRequest from a JSON string
 search_request_instance = SearchRequest.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/SearchResponse.md b/docs/SearchResponse.md
@@ -18,8 +18,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.search_response import SearchResponse
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of SearchResponse from a JSON string
 search_response_instance = SearchResponse.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/SearchResponseHits.md b/docs/SearchResponseHits.md
@@ -16,8 +16,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.search_response_hits import SearchResponseHits
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of SearchResponseHits from a JSON string
 search_response_hits_instance = SearchResponseHits.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/SourceRules.md b/docs/SourceRules.md
@@ -14,8 +14,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.source_rules import SourceRules
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of SourceRules from a JSON string
 source_rules_instance = SourceRules.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/SuccessResponse.md b/docs/SuccessResponse.md
@@ -18,8 +18,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.success_response import SuccessResponse
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of SuccessResponse from a JSON string
 success_response_instance = SuccessResponse.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/UpdateDocumentRequest.md b/docs/UpdateDocumentRequest.md
@@ -17,8 +17,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.update_document_request import UpdateDocumentRequest
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of UpdateDocumentRequest from a JSON string
 update_document_request_instance = UpdateDocumentRequest.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/UpdateResponse.md b/docs/UpdateResponse.md
@@ -16,8 +16,6 @@ Name | Type | Description | Notes
 ```python
 from manticoresearch.models.update_response import UpdateResponse
 
-# TODO update the JSON string below
-json = "{}"
 # create an instance of UpdateResponse from a JSON string
 update_response_instance = UpdateResponse.from_json(json)
 # print the JSON string representation of the object
diff --git a/docs/UtilsApi.md b/docs/UtilsApi.md
