fix(specs): ingestion push task payload [skip-bc] (#3607)

Co-authored-by: Pierre Millot <[email protected]>
algolia · Aug 29, 2024 · 327e08d · 327e08d
1 parent cdd6f0d
commit 327e08d
Show file tree

Hide file tree

Showing 11 changed files with 64 additions and 66 deletions.
diff --git a/specs/ingestion/paths/tasks/v2/pushTask.yml b/specs/ingestion/paths/tasks/v2/pushTask.yml
@@ -15,7 +15,25 @@ post:
     content:
       application/json:
         schema:
-          $ref: '../../../../common/schemas/Batch.yml#/batchWriteParams'
+          title: pushTaskPayload
+          type: object
+          properties:
+            action:
+              $ref: '../../../../common/schemas/Batch.yml#/action'
+            records:
+              type: array
+              items:
+                title: pushTaskRecords
+                type: object
+                additionalProperties: true
+                required:
+                  - objectID
+                properties:
+                  objectID:
+                    $ref: '../../../../common/parameters.yml#/objectID'
+          required:
+            - action
+            - records
     required: true
   responses:
     '200':

diff --git a/templates/csharp/tests/generateInnerParams.mustache b/templates/csharp/tests/generateInnerParams.mustache
@@ -25,8 +25,13 @@
 {{#isObject}}
   {{#oneOfModel}}new {{{parentClassName}}}({{/oneOfModel}}new {{{objectName}}}{
     {{#value}}
-      {{#isAdditionalProperty}}AdditionalProperties = new Dictionary<string, object>{ {"{{{key}}}", {{> tests/generateParams}} } }{{/isAdditionalProperty}}
       {{^isAdditionalProperty}}{{#lambda.pascalcase}}{{#lambda.csharpIdentifier}}{{&key}}{{/lambda.csharpIdentifier}}{{/lambda.pascalcase}} = {{> tests/generateParams}},{{/isAdditionalProperty}}{{/value}}
+    {{#hasAdditionalProperties}}
+    AdditionalProperties = new Dictionary<string, object>{
+    {{#value}}
+      {{#isAdditionalProperty}} {"{{{key}}}", {{> tests/generateParams}} },{{/isAdditionalProperty}}{{/value}}
+    }
+    {{/hasAdditionalProperties}}
   }{{#oneOfModel}}){{/oneOfModel}}
 {{/isObject}}
 {{#isFreeFormObject}}

diff --git a/templates/go/model_simple.mustache b/templates/go/model_simple.mustache
@@ -123,7 +123,7 @@ func (o *{{classname}}) Get{{name}}Ok() ({{^isArray}}{{^isFreeFormObject}}*{{/is
 {{#deprecated}}
 // Deprecated
 {{/deprecated}}
-func (o *{{classname}}) Set{{name}}(v {{#isModel}}*{{/isModel}}{{vendorExtensions.x-go-base-type}}) *{{classname}} {
+func (o *{{classname}}) Set{{name}}(v {{#isModel}}{{^isArray}}{{^isFreeFormObject}}*{{/isFreeFormObject}}{{/isArray}}{{/isModel}}{{vendorExtensions.x-go-base-type}}) *{{classname}} {
 {{#isNullable}}
 {{#vendorExtensions.x-golang-is-container}}
 	o.{{name}} = v
@@ -133,7 +133,7 @@ func (o *{{classname}}) Set{{name}}(v {{#isModel}}*{{/isModel}}{{vendorExtension
 {{/vendorExtensions.x-golang-is-container}}
 {{/isNullable}}
 {{^isNullable}}
-	o.{{name}} = {{#isModel}}*{{/isModel}}v
+	o.{{name}} = {{#isModel}}{{^isArray}}{{^isFreeFormObject}}*{{/isFreeFormObject}}{{/isArray}}{{/isModel}}v
 {{/isNullable}}
   return o
 }
@@ -200,7 +200,7 @@ func (o *{{classname}}) Has{{name}}() bool {
 {{#deprecated}}
 // Deprecated
 {{/deprecated}}
-func (o *{{classname}}) Set{{name}}(v {{#isModel}}*{{/isModel}}{{vendorExtensions.x-go-base-type}}) *{{classname}} {
+func (o *{{classname}}) Set{{name}}(v {{#isModel}}{{^isArray}}{{^isFreeFormObject}}*{{/isFreeFormObject}}{{/isArray}}{{/isModel}}{{vendorExtensions.x-go-base-type}}) *{{classname}} {
 {{#isNullable}}
 {{#vendorExtensions.x-golang-is-container}}
 	o.{{name}} = v
@@ -443,4 +443,4 @@ func (o {{classname}}) String() string {
 	}
 	{{/isAdditionalPropertiesTrue}}
   return fmt.Sprintf("{{classname}} {\n%s}", out)
-}
+}
diff --git a/templates/kotlin/snippets/method.mustache b/templates/kotlin/snippets/method.mustache
@@ -18,29 +18,7 @@ class Snippet{{client}} {
       val client = {{client}}(appId = "YOUR_APP_ID", apiKey = "YOUR_API_KEY"{{#hasRegionalHost}}, region = "YOUR_APP_ID_REGION"{{/hasRegionalHost}})
 
       // Call the API
-      var response = client.{{method}}(
-        {{#parametersWithDataType}}
-        {{> tests/request_param}}
-        {{/parametersWithDataType}}
-        {{#hasRequestOptions}}
-        requestOptions = RequestOptions(
-            {{#requestOptions.queryParameters}}
-            urlParameters = buildMap {
-                {{#parametersWithDataType}}
-                put("{{{key}}}", {{> tests/param_value}})
-                {{/parametersWithDataType}}
-            },
-            {{/requestOptions.queryParameters}}
-            {{#requestOptions.headers}}
-            headers = buildMap {
-            {{#parametersWithDataType}}
-                put("{{{key}}}", {{> tests/param_value}})
-            {{/parametersWithDataType}}
-            },
-            {{/requestOptions.headers}}
-        )
-        {{/hasRequestOptions}}
-      )
+      var response = client.{{> tests/method}}
 
       // Use the response
       println(response)

diff --git a/templates/kotlin/tests/client/method.mustache b/templates/kotlin/tests/client/method.mustache
@@ -1,5 +1 @@
-client.{{method}}(
-    {{#parametersWithDataType}}
-    {{> tests/request_param}}
-    {{/parametersWithDataType}}
-)
+client.{{> tests/method}}
diff --git a/templates/kotlin/tests/client/tests.mustache b/templates/kotlin/tests/client/tests.mustache
@@ -20,11 +20,7 @@ fun `{{#lambda.replaceBacktick}}{{{testName}}}{{/lambda.replaceBacktick}}`() = r
     {{#isMethod}}
     client.runTest(
           call = {
-            {{method}}(
-                {{#parametersWithDataType}}
-                {{> tests/request_param}}
-                {{/parametersWithDataType}}
-            )
+            {{> tests/method}}
           },
           {{#match}}
           {{^testResponse}}

diff --git a/templates/kotlin/tests/param_object.mustache b/templates/kotlin/tests/param_object.mustache
@@ -1,5 +1,10 @@
 {{{objectName}}}(
 {{#value}}
-{{> tests/request_param}}
+{{^isAdditionalProperty}}
+{{#hasAdditionalProperties}}{{#lambda.camelcase}}{{{key}}}{{/lambda.camelcase}} = {{/hasAdditionalProperties}}{{> tests/request_param}}
+{{/isAdditionalProperty}}
 {{/value}}
+{{#hasAdditionalProperties}}
+additionalProperties = mapOf({{#value}}{{#isAdditionalProperty}}"{{key}}" to {{> tests/param_json_element}}{{/isAdditionalProperty}}{{/value}})
+{{/hasAdditionalProperties}}
 )
diff --git a/templates/kotlin/tests/request_param.mustache b/templates/kotlin/tests/request_param.mustache
@@ -1 +1 @@
-{{^isAdditionalProperty}}{{#lambda.camelcase}}{{{key}}}{{/lambda.camelcase}} = {{> tests/param_value}}{{/isAdditionalProperty}}{{#isAdditionalProperty}}additionalProperties = mapOf("{{key}}" to {{> tests/param_json_element}}){{/isAdditionalProperty}}
+{{^hasAdditionalProperties}}{{#lambda.camelcase}}{{{key}}}{{/lambda.camelcase}} = {{> tests/param_value}}{{/hasAdditionalProperties}}{{#hasAdditionalProperties}}{{> tests/param_value}}{{/hasAdditionalProperties}}
diff --git a/templates/scala/tests/param_object.mustache b/templates/scala/tests/param_object.mustache
@@ -1,5 +1,11 @@
 {{{objectName}}}(
 {{#value}}
-{{> tests/request_param}},
+{{^isAdditionalProperty}}
+{{#lambda.scalaIdentifier}}{{&key}}{{/lambda.scalaIdentifier}} = {{> tests/param_optional}},
+{{/isAdditionalProperty}}
 {{/value}}
+{{#hasAdditionalProperties}}
+additionalProperties = Some(List({{#value}}{{#isAdditionalProperty}}JField("{{key}}", {{> tests/param_json_element}}),
+{{/isAdditionalProperty}}{{/value}}))
+{{/hasAdditionalProperties}}
 )
diff --git a/templates/scala/tests/request_param.mustache b/templates/scala/tests/request_param.mustache
@@ -1 +1 @@
-{{^isAdditionalProperty}}{{#lambda.scalaIdentifier}}{{&key}}{{/lambda.scalaIdentifier}} = {{> tests/param_optional}}{{/isAdditionalProperty}}{{#isAdditionalProperty}}additionalProperties = Some(List(JField("{{key}}", {{> tests/param_json_element}}))){{/isAdditionalProperty}}
+{{^hasAdditionalProperties}}{{#lambda.scalaIdentifier}}{{&key}}{{/lambda.scalaIdentifier}} = {{> tests/param_optional}}{{/hasAdditionalProperties}}{{#hasAdditionalProperties}}{{> tests/param_value}}{{/hasAdditionalProperties}}
diff --git a/tests/CTS/requests/ingestion/pushTask.json b/tests/CTS/requests/ingestion/pushTask.json
@@ -2,21 +2,18 @@
   {
     "parameters": {
       "taskID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
-      "batchWriteParams": {
-        "requests": [
+      "pushTaskPayload": {
+        "action": "addObject",
+        "records": [
           {
-            "action": "addObject",
-            "body": {
-              "key": "bar",
-              "foo": "1"
-            }
+            "key": "bar",
+            "foo": "1",
+            "objectID": "o"
           },
           {
-            "action": "addObject",
-            "body": {
-              "key": "baz",
-              "foo": "2"
-            }
+            "key": "baz",
+            "foo": "2",
+            "objectID": "k"
           }
         ]
       }
@@ -25,20 +22,17 @@
       "path": "/2/tasks/6c02aeb1-775e-418e-870b-1faccd4b2c0f/push",
       "method": "POST",
       "body": {
-        "requests": [
+        "action": "addObject",
+        "records": [
           {
-            "action": "addObject",
-            "body": {
-              "key": "bar",
-              "foo": "1"
-            }
+            "key": "bar",
+            "foo": "1",
+            "objectID": "o"
           },
           {
-            "action": "addObject",
-            "body": {
-              "key": "baz",
-              "foo": "2"
-            }
+            "key": "baz",
+            "foo": "2",
+            "objectID": "k"
           }
         ]
       }