Specify accepted types for UpsertRows values (DataDog#3567)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -7075,19 +7075,27 @@ components:
     BatchUpsertRowsRequestDataAttributes:
       description: Attributes containing row data values for row creation or update
         operations.
+      example:
+        values: {}
       properties:
         values:
           additionalProperties:
-            x-required-field: true
-          description: Key-value pairs representing row data, where keys are field
-            names from the schema.
-          example:
-            example_key_value: primary_key_value
-            name: row_name
+            $ref: '#/components/schemas/BatchUpsertRowsRequestDataAttributesValue'
+          description: Key-value pairs representing row data, where keys are schema
+            field names and values match the corresponding column types.
           type: object
       required:
       - values
       type: object
+    BatchUpsertRowsRequestDataAttributesValue:
+      description: Types allowed for Reference Table row values.
+      oneOf:
+      - example: row_name
+        type: string
+      - example: 25
+        format: int32
+        maximum: 2147483647
+        type: integer
     BillConfig:
       description: Bill config.
       properties:
@@ -79483,6 +79491,18 @@ paths:
       requestBody:
         content:
           application/json:
+            examples:
+              happy_path:
+                summary: Upsert a row with mixed string and int values
+                value:
+                  data:
+                  - attributes:
+                      values:
+                        age: 25
+                        example_key_value: primary_key_value
+                        name: row_name
+                    id: primary_key_value
+                    type: row
             schema:
               $ref: '#/components/schemas/BatchUpsertRowsRequestArray'
         required: true

api/datadogV2/model_batch_upsert_rows_request_data_attributes.go

@@ -12,8 +12,8 @@ import (
 
 // BatchUpsertRowsRequestDataAttributes Attributes containing row data values for row creation or update operations.
 type BatchUpsertRowsRequestDataAttributes struct {
-	// Key-value pairs representing row data, where keys are field names from the schema.
-	Values map[string]interface{} `json:"values"`
+	// Key-value pairs representing row data, where keys are schema field names and values match the corresponding column types.
+	Values map[string]BatchUpsertRowsRequestDataAttributesValue `json:"values"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`
 	AdditionalProperties map[string]interface{} `json:"-"`
@@ -23,7 +23,7 @@ type BatchUpsertRowsRequestDataAttributes struct {
 // This constructor will assign default values to properties that have it defined,
 // and makes sure properties required by API are set, but the set of arguments
 // will change when the set of required properties is changed.
-func NewBatchUpsertRowsRequestDataAttributes(values map[string]interface{}) *BatchUpsertRowsRequestDataAttributes {
+func NewBatchUpsertRowsRequestDataAttributes(values map[string]BatchUpsertRowsRequestDataAttributesValue) *BatchUpsertRowsRequestDataAttributes {
 	this := BatchUpsertRowsRequestDataAttributes{}
 	this.Values = values
 	return &this
@@ -38,25 +38,25 @@ func NewBatchUpsertRowsRequestDataAttributesWithDefaults() *BatchUpsertRowsReque
 }
 
 // GetValues returns the Values field value.
-func (o *BatchUpsertRowsRequestDataAttributes) GetValues() map[string]interface{} {
+func (o *BatchUpsertRowsRequestDataAttributes) GetValues() map[string]BatchUpsertRowsRequestDataAttributesValue {
 	if o == nil {
-		var ret map[string]interface{}
+		var ret map[string]BatchUpsertRowsRequestDataAttributesValue
 		return ret
 	}
 	return o.Values
 }
 
 // GetValuesOk returns a tuple with the Values field value
 // and a boolean to check if the value has been set.
-func (o *BatchUpsertRowsRequestDataAttributes) GetValuesOk() (*map[string]interface{}, bool) {
+func (o *BatchUpsertRowsRequestDataAttributes) GetValuesOk() (*map[string]BatchUpsertRowsRequestDataAttributesValue, bool) {
 	if o == nil {
 		return nil, false
 	}
 	return &o.Values, true
 }
 
 // SetValues sets field value.
-func (o *BatchUpsertRowsRequestDataAttributes) SetValues(v map[string]interface{}) {
+func (o *BatchUpsertRowsRequestDataAttributes) SetValues(v map[string]BatchUpsertRowsRequestDataAttributesValue) {
 	o.Values = v
 }
 
@@ -77,7 +77,7 @@ func (o BatchUpsertRowsRequestDataAttributes) MarshalJSON() ([]byte, error) {
 // UnmarshalJSON deserializes the given payload.
 func (o *BatchUpsertRowsRequestDataAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		Values *map[string]interface{} `json:"values"`
+		Values *map[string]BatchUpsertRowsRequestDataAttributesValue `json:"values"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)

api/datadogV2/model_batch_upsert_rows_request_data_attributes_value.go

@@ -0,0 +1,105 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+package datadogV2
+
+import (
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+)
+
+// BatchUpsertRowsRequestDataAttributesValue - Types allowed for Reference Table row values.
+type BatchUpsertRowsRequestDataAttributesValue struct {
+	String *string
+	Int32  *int32
+
+	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
+	UnparsedObject interface{}
+}
+
+// StringAsBatchUpsertRowsRequestDataAttributesValue is a convenience function that returns string wrapped in BatchUpsertRowsRequestDataAttributesValue.
+func StringAsBatchUpsertRowsRequestDataAttributesValue(v *string) BatchUpsertRowsRequestDataAttributesValue {
+	return BatchUpsertRowsRequestDataAttributesValue{String: v}
+}
+
+// Int32AsBatchUpsertRowsRequestDataAttributesValue is a convenience function that returns int32 wrapped in BatchUpsertRowsRequestDataAttributesValue.
+func Int32AsBatchUpsertRowsRequestDataAttributesValue(v *int32) BatchUpsertRowsRequestDataAttributesValue {
+	return BatchUpsertRowsRequestDataAttributesValue{Int32: v}
+}
+
+// UnmarshalJSON turns data into one of the pointers in the struct.
+func (obj *BatchUpsertRowsRequestDataAttributesValue) UnmarshalJSON(data []byte) error {
+	var err error
+	match := 0
+	// try to unmarshal data into String
+	err = datadog.Unmarshal(data, &obj.String)
+	if err == nil {
+		if obj.String != nil {
+			jsonString, _ := datadog.Marshal(obj.String)
+			if string(jsonString) == "{}" { // empty struct
+				obj.String = nil
+			} else {
+				match++
+			}
+		} else {
+			obj.String = nil
+		}
+	} else {
+		obj.String = nil
+	}
+
+	// try to unmarshal data into Int32
+	err = datadog.Unmarshal(data, &obj.Int32)
+	if err == nil {
+		if obj.Int32 != nil {
+			jsonInt32, _ := datadog.Marshal(obj.Int32)
+			if string(jsonInt32) == "{}" { // empty struct
+				obj.Int32 = nil
+			} else {
+				match++
+			}
+		} else {
+			obj.Int32 = nil
+		}
+	} else {
+		obj.Int32 = nil
+	}
+
+	if match != 1 { // more than 1 match
+		// reset to nil
+		obj.String = nil
+		obj.Int32 = nil
+		return datadog.Unmarshal(data, &obj.UnparsedObject)
+	}
+	return nil // exactly one match
+}
+
+// MarshalJSON turns data from the first non-nil pointers in the struct to JSON.
+func (obj BatchUpsertRowsRequestDataAttributesValue) MarshalJSON() ([]byte, error) {
+	if obj.String != nil {
+		return datadog.Marshal(&obj.String)
+	}
+
+	if obj.Int32 != nil {
+		return datadog.Marshal(&obj.Int32)
+	}
+
+	if obj.UnparsedObject != nil {
+		return datadog.Marshal(obj.UnparsedObject)
+	}
+	return nil, nil // no data in oneOf schemas
+}
+
+// GetActualInstance returns the actual instance.
+func (obj *BatchUpsertRowsRequestDataAttributesValue) GetActualInstance() interface{} {
+	if obj.String != nil {
+		return obj.String
+	}
+
+	if obj.Int32 != nil {
+		return obj.Int32
+	}
+
+	// all schemas are nil
+	return nil
+}

examples/v2/reference-tables/UpsertRows.go

@@ -16,10 +16,7 @@ func main() {
 		Data: []datadogV2.BatchUpsertRowsRequestData{
 			{
 				Attributes: &datadogV2.BatchUpsertRowsRequestDataAttributes{
-					Values: map[string]interface{}{
-						"example_key_value": "primary_key_value",
-						"name":              "row_name",
-					},
+					Values: map[string]datadogV2.BatchUpsertRowsRequestDataAttributesValue{},
 				},
 				Id:   "primary_key_value",
 				Type: datadogV2.TABLEROWRESOURCEDATATYPE_ROW,

tests/scenarios/features/v2/reference_tables.feature

@@ -148,22 +148,22 @@ Feature: Reference Tables
   Scenario: Upsert rows returns "Bad Request" response
     Given new "UpsertRows" request
     And request contains "id" parameter from "REPLACE.ME"
-    And body with value {"data": [{"attributes": {"values": {"example_key_value": "primary_key_value", "name": "row_name"}}, "id": "primary_key_value", "type": "row"}]}
+    And body with value {"data": [{"attributes": {"values": {}}, "id": "primary_key_value", "type": "row"}]}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/redapl-experiences
   Scenario: Upsert rows returns "Not Found" response
     Given new "UpsertRows" request
     And request contains "id" parameter from "REPLACE.ME"
-    And body with value {"data": [{"attributes": {"values": {"example_key_value": "primary_key_value", "name": "row_name"}}, "id": "primary_key_value", "type": "row"}]}
+    And body with value {"data": [{"attributes": {"values": {}}, "id": "primary_key_value", "type": "row"}]}
     When the request is sent
     Then the response status is 404 Not Found
 
   @generated @skip @team:DataDog/redapl-experiences
   Scenario: Upsert rows returns "Rows created or updated successfully" response
     Given new "UpsertRows" request
     And request contains "id" parameter from "REPLACE.ME"
-    And body with value {"data": [{"attributes": {"values": {"example_key_value": "primary_key_value", "name": "row_name"}}, "id": "primary_key_value", "type": "row"}]}
+    And body with value {"data": [{"attributes": {"values": {}}, "id": "primary_key_value", "type": "row"}]}
     When the request is sent
     Then the response status is 200 Rows created or updated successfully