feat: add dirty values parameter for single document indexing

- add `dirty_values` parameter for .Create, .Upsert and .Update methods - pull latest oapi-spec changes
typesense · Oct 3, 2024 · 77722d7 · 77722d7
1 parent 90638ca
commit 77722d7
Show file tree

Hide file tree

Showing 14 changed files with 139 additions and 91 deletions.
diff --git a/typesense/api/client.go b/typesense/api/client.go
@@ -16,3 +16,9 @@ func WithAPIKey(apiKey string) ClientOption {
 		return nil
 	}
 }
+
+// Manually defining this unreferenced schema here instead of disabling oapi-codegen schema pruning
+
+type DocumentIndexParameters struct {
+	DirtyValues *DirtyValues `json:"dirty_values,omitempty"`
+}
diff --git a/typesense/api/client_gen.go b/typesense/api/client_gen.go
diff --git a/typesense/api/generator/generator.yml b/typesense/api/generator/generator.yml
@@ -472,6 +472,8 @@ components:
                   type: string
                 project_id:
                   type: string
+                url:
+                  type: string
               required:
                 - model_name
               type: object
@@ -2151,6 +2153,11 @@ paths:
           required: true
           schema:
             type: string
+        - description: Dealing with Dirty Data
+          in: query
+          name: dirty_values
+          schema:
+            $ref: '#/components/schemas/DirtyValues'
       requestBody:
         content:
           application/json:
@@ -2605,7 +2612,7 @@ paths:
       summary: List all collection overrides
       tags:
         - documents
-        - promote
+        - curation
   /collections/{collectionName}/overrides/{overrideId}:
     delete:
       operationId: deleteSearchOverride
@@ -2638,7 +2645,7 @@ paths:
       summary: Delete an override associated with a collection
       tags:
         - documents
-        - promote
+        - curation
     get:
       description: Retrieve the details of a search override, given its id.
       operationId: getSearchOverride
@@ -2705,7 +2712,7 @@ paths:
       summary: Create or update an override to promote certain documents over others
       tags:
         - documents
-        - promote
+        - curation
   /collections/{collectionName}/synonyms:
     get:
       operationId: getSearchSynonyms
@@ -3657,11 +3664,11 @@ tags:
       description: Find out more
       url: https://typesense.org/api/#index-document
     name: documents
-  - description: Promote certain documents over others
+  - description: Hand-curate search results based on conditional business rules
     externalDocs:
       description: Find out more
       url: https://typesense.org/docs/0.23.0/api/#curation
-    name: promote
+    name: curation
   - description: Typesense can aggregate search queries for both analytics purposes and for query suggestions.
     externalDocs:
       description: Find out more

diff --git a/typesense/api/generator/openapi.yml b/typesense/api/generator/openapi.yml
@@ -19,8 +19,8 @@ tags:
     externalDocs:
       description: Find out more
       url: https://typesense.org/api/#index-document
-  - name: promote
-    description: Promote certain documents over others
+  - name: curation
+    description: Hand-curate search results based on conditional business rules
     externalDocs:
       description: Find out more
       url: https://typesense.org/docs/0.23.0/api/#curation
@@ -412,7 +412,7 @@ paths:
     get:
       tags:
         - documents
-        - promote
+        - curation
       summary: List all collection overrides
       operationId: getSearchOverrides
       parameters:
@@ -460,7 +460,7 @@ paths:
     put:
       tags:
         - documents
-        - promote
+        - curation
       summary: Create or update an override to promote certain documents over others
       description:
         Create or update an override to promote certain documents over others.
@@ -502,7 +502,7 @@ paths:
     delete:
       tags:
         - documents
-        - promote
+        - curation
       summary: Delete an override associated with a collection
       operationId: deleteSearchOverride
       parameters:
@@ -842,6 +842,11 @@ paths:
           required: true
           schema:
             type: string
+        - name: dirty_values
+          in: query
+          description: Dealing with Dirty Data
+          schema:
+            $ref: "#/components/schemas/DirtyValues"
       requestBody:
         description: The document object with fields to be updated
         content:
@@ -1784,12 +1789,12 @@ components:
             maxLength: 1
           default: []
         enable_nested_fields:
-            type: boolean
-            description:
-              Enables experimental support at a collection level for nested object or object array fields.
-              This field is only available if the Typesense server is version `0.24.0.rcn34` or later.
-            default: false
-            example: true
+          type: boolean
+          description:
+            Enables experimental support at a collection level for nested object or object array fields.
+            This field is only available if the Typesense server is version `0.24.0.rcn34` or later.
+          default: false
+          example: true
         symbols_to_index:
           type: array
           description: >
@@ -1919,6 +1924,8 @@ components:
                   type: string
                 api_key:
                   type: string
+                url:
+                  type: string
                 access_token:
                   type: string
                 client_id:
@@ -2436,8 +2443,8 @@ components:
             If infix index is enabled for this field, infix searching can be done on a per-field
             basis by sending a comma separated string parameter called infix to the search query.
             This parameter can have 3 values; `off` infix search is disabled, which is default
-             `always` infix search is performed along with regular search
-             `fallback` infix search is performed if regular search does not produce results
+            `always` infix search is performed along with regular search
+            `fallback` infix search is performed if regular search does not produce results
           type: string
 
         max_extra_prefix:
@@ -2773,7 +2780,7 @@ components:
           type: boolean
         conversation_model_id:
           description: >
-             The Id of Conversation Model to be used.
+            The Id of Conversation Model to be used.
           type: string
         conversation_id:
           description: >
@@ -2821,8 +2828,8 @@ components:
             If infix index is enabled for this field, infix searching can be done on a per-field
             basis by sending a comma separated string parameter called infix to the search query.
             This parameter can have 3 values; `off` infix search is disabled, which is default
-             `always` infix search is performed along with regular search
-             `fallback` infix search is performed if regular search does not produce results
+            `always` infix search is performed along with regular search
+            `fallback` infix search is performed if regular search does not produce results
           type: string
 
         max_extra_prefix:
@@ -3143,7 +3150,7 @@ components:
           type: boolean
         conversation_model_id:
           description: >
-             The Id of Conversation Model to be used.
+            The Id of Conversation Model to be used.
           type: string
         conversation_id:
           description: >

diff --git a/typesense/api/types_gen.go b/typesense/api/types_gen.go
diff --git a/typesense/document.go b/typesense/document.go
@@ -5,11 +5,13 @@ import (
 	"encoding/json"
 	"io"
 	"strings"
+
+	"github.com/typesense/typesense-go/v2/typesense/api"
 )
 
 type DocumentInterface[T any] interface {
 	Retrieve(ctx context.Context) (T, error)
-	Update(ctx context.Context, document any) (T, error)
+	Update(ctx context.Context, document any, params *api.DocumentIndexParameters) (T, error)
 	Delete(ctx context.Context) (T, error)
 }
 
@@ -39,9 +41,9 @@ func (d *document[T]) Retrieve(ctx context.Context) (resp T, err error) {
 	return resp, nil
 }
 
-func (d *document[T]) Update(ctx context.Context, document any) (resp T, err error) {
+func (d *document[T]) Update(ctx context.Context, document any, params *api.DocumentIndexParameters) (resp T, err error) {
 	response, err := d.apiClient.UpdateDocument(ctx,
-		d.collectionName, d.documentID, document)
+		d.collectionName, d.documentID, &api.UpdateDocumentParams{DirtyValues: params.DirtyValues}, document)
 	if err != nil {
 		return resp, err
 	}