Fixed id format in replace request, updated search response format

manticoresoftware · Jan 8, 2025 · c2fb2fd · c2fb2fd
1 parent 97419cf
commit c2fb2fd
Show file tree

Hide file tree

Showing 6 changed files with 89 additions and 11 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -41,7 +41,7 @@ paths:
              - _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.
+        In addition, if profiling is enabled, the response will include an additional array with profiling information attached. Also, if pagination is enabled, the response will include an additional 'scroll' property with a scroll token to use for pagination
         Here is an example search response:
 
           ```
@@ -442,7 +442,8 @@ paths:
         name: id
         required: true
         schema:
-          type: number
+          format: int64
+          type: integer
         style: simple
       requestBody:
         content:
@@ -666,9 +667,10 @@ components:
             $ref: '#/components/schemas/queryFilterAlias2'
           type: array
     bulkResponse:
-      additionalProperties: false
       description: Success response for bulk search requests
       example:
+        current_line: 0
+        skipped_lines: 6
         error: error
         items:
         - "{}"
@@ -686,6 +688,12 @@ components:
         error:
           description: Error message describing an error if such occurred
           type: string
+        current_line:
+          description: Number of the row returned in the response
+          type: integer
+        skipped_lines:
+          description: Number of rows skipped in the response
+          type: integer
     deleteDocumentRequest:
       description: |
         Payload for delete request.
@@ -1040,6 +1048,9 @@ components:
         _index:
           description: Name of the document index
           type: string
+        table:
+          description: Name of the document table (alias of index)
+          type: string
         _id:
           description: ID of the document affected by the request operation
           format: int64
@@ -1082,6 +1093,7 @@ components:
               gid: 20
         took: 0
         profile: "{}"
+        scroll: scroll
         warning: "{}"
         timed_out: true
         aggregations: "{}"
@@ -1102,6 +1114,9 @@ components:
           description: "Profile information about the search execution, if profiling\
             \ is enabled"
           type: object
+        scroll:
+          description: Scroll token to be used fo pagination
+          type: string
         warning:
           additionalProperties: false
           description: Warnings encountered during the search operation
@@ -1151,13 +1166,13 @@ components:
     sqlObjResponse:
       type: object
     sqlResponse:
+      anyOf:
+      - $ref: '#/components/schemas/sqlRawResponse'
+      - $ref: '#/components/schemas/sqlObjResponse'
       description: List of responses from executed SQL queries
       example:
       - total: 0
         error: null
-      oneOf:
-      - $ref: '#/components/schemas/sqlRawResponse'
-      - $ref: '#/components/schemas/sqlObjResponse'
     updateDocumentRequest:
       description: Payload for updating a document or multiple documents in an index
       properties:

diff --git a/api_index.go b/api_index.go
diff --git a/api_search.go b/api_search.go
diff --git a/docs/IndexAPI.md b/docs/IndexAPI.md
@@ -233,7 +233,7 @@ import (
 
 func main() {
 	index := "index_example" // string | Name of the percolate index
-	id := float32(8.14) // float32 | Id of the document to replace
+	id := int64(789) // int64 | Id of the document to replace
 	replaceDocumentRequest := *openapiclient.NewReplaceDocumentRequest(map[string]interface{}(123)) // ReplaceDocumentRequest | 
 
 	configuration := openapiclient.NewConfiguration()
@@ -255,7 +255,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
 **index** | **string** | Name of the percolate index | 
-**id** | **float32** | Id of the document to replace | 
+**id** | **int64** | Id of the document to replace | 
 
 ### Other Parameters
 

diff --git a/docs/SearchResponse.md b/docs/SearchResponse.md
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **Aggregations** | Pointer to **map[string]interface{}** | Aggregated search results grouped by the specified criteria | [optional] 
 **Hits** | Pointer to [**SearchResponseHits**](SearchResponseHits.md) |  | [optional] 
 **Profile** | Pointer to **map[string]interface{}** | Profile information about the search execution, if profiling is enabled | [optional] 
+**Scroll** | Pointer to **string** | Scroll token to be used fo pagination | [optional] 
 **Warning** | Pointer to **map[string]interface{}** | Warnings encountered during the search operation | [optional] 
 
 ## Methods
@@ -155,6 +156,31 @@ SetProfile sets Profile field to given value.
 
 HasProfile returns a boolean if a field has been set.
 
+### GetScroll
+
+`func (o *SearchResponse) GetScroll() string`
+
+GetScroll returns the Scroll field if non-nil, zero value otherwise.
+
+### GetScrollOk
+
+`func (o *SearchResponse) GetScrollOk() (*string, bool)`
+
+GetScrollOk returns a tuple with the Scroll field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetScroll
+
+`func (o *SearchResponse) SetScroll(v string)`
+
+SetScroll sets Scroll field to given value.
+
+### HasScroll
+
+`func (o *SearchResponse) HasScroll() bool`
+
+HasScroll returns a boolean if a field has been set.
+
 ### GetWarning
 
 `func (o *SearchResponse) GetWarning() map[string]interface{}`

diff --git a/model_search_response.go b/model_search_response.go