Add Batch Rows Query Endpoint to Reference Tables API spec (#3835)

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

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

.generator/schemas/v2/openapi.yaml

@@ -7475,23 +7475,89 @@ components:
       properties:
         data:
           items:
-            $ref: '#/components/schemas/BatchDeleteRowsRequestData'
+            $ref: '#/components/schemas/TableRowResourceIdentifier'
           maxItems: 200
           type: array
       required:
       - data
       type: object
-    BatchDeleteRowsRequestData:
-      description: Row resource containing a single row identifier for deletion.
+    BatchRowsQueryDataType:
+      default: reference-tables-batch-rows-query
+      description: Resource type identifier for batch queries of reference table rows.
+      enum:
+      - reference-tables-batch-rows-query
+      example: reference-tables-batch-rows-query
+      type: string
+      x-enum-varnames:
+      - REFERENCE_TABLES_BATCH_ROWS_QUERY
+    BatchRowsQueryRequest:
+      properties:
+        data:
+          $ref: '#/components/schemas/BatchRowsQueryRequestData'
+      type: object
+    BatchRowsQueryRequestData:
+      properties:
+        attributes:
+          $ref: '#/components/schemas/BatchRowsQueryRequestDataAttributes'
+        type:
+          $ref: '#/components/schemas/BatchRowsQueryDataType'
+      required:
+      - type
+      type: object
+    BatchRowsQueryRequestDataAttributes:
+      properties:
+        row_ids:
+          example:
+          - row_id_1
+          - row_id_2
+          items:
+            type: string
+          type: array
+        table_id:
+          example: 00000000-0000-0000-0000-000000000000
+          type: string
+      required:
+      - row_ids
+      - table_id
+      type: object
+    BatchRowsQueryResponse:
+      example:
+        data:
+          id: 00000000-0000-0000-0000-000000000000
+          relationships:
+            rows:
+              data:
+              - id: row_id_1
+                type: row
+              - id: row_id_2
+                type: row
+          type: reference-tables-batch-rows-query
+      properties:
+        data:
+          $ref: '#/components/schemas/BatchRowsQueryResponseData'
+      type: object
+    BatchRowsQueryResponseData:
       properties:
         id:
-          example: primary_key_value
           type: string
+        relationships:
+          $ref: '#/components/schemas/BatchRowsQueryResponseDataRelationships'
         type:
-          $ref: '#/components/schemas/TableRowResourceDataType'
+          $ref: '#/components/schemas/BatchRowsQueryDataType'
       required:
       - type
-      - id
+      type: object
+    BatchRowsQueryResponseDataRelationships:
+      properties:
+        rows:
+          $ref: '#/components/schemas/BatchRowsQueryResponseDataRelationshipsRows'
+      type: object
+    BatchRowsQueryResponseDataRelationshipsRows:
+      properties:
+        data:
+          items:
+            $ref: '#/components/schemas/TableRowResourceIdentifier'
+          type: array
       type: object
     BatchUpsertRowsRequestArray:
       description: The request body for creating or updating multiple rows into a
@@ -66953,6 +67019,18 @@ components:
       type: string
       x-enum-varnames:
       - ROW
+    TableRowResourceIdentifier:
+      description: Row resource containing a single row identifier.
+      properties:
+        id:
+          example: primary_key_value
+          type: string
+        type:
+          $ref: '#/components/schemas/TableRowResourceDataType'
+      required:
+      - type
+      - id
+      type: object
     TagsEventAttribute:
       description: Array of tags associated with your event.
       example:
@@ -96388,6 +96466,57 @@ paths:
         operator: OR
         permissions:
         - timeseries_query
+  /api/v2/reference-tables/queries/batch-rows:
+    post:
+      description: Batch query reference table rows by their primary key values.  Returns
+        only found rows in the included array.
+      operationId: BatchRowsQuery
+      requestBody:
+        content:
+          application/json:
+            examples:
+              happy_path:
+                summary: Batch query reference table rows by their primary key values.
+                value:
+                  data:
+                    attributes:
+                      row_ids:
+                      - row_id_1
+                      - row_id_2
+                      table_id: 00000000-0000-0000-0000-000000000000
+                    type: reference-tables-batch-rows-query
+            schema:
+              $ref: '#/components/schemas/BatchRowsQueryRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/BatchRowsQueryResponse'
+          description: Successfully retrieved rows. Some or all requested rows were
+            found. Response includes found rows in the included section.
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+        '500':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Internal Server Error
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ: []
+      summary: Batch rows query
+      tags:
+      - Reference Tables
   /api/v2/reference-tables/tables:
     get:
       description: List all reference tables in this organization.

api/datadogV2/api_reference_tables.go

@@ -16,6 +16,86 @@ import (
 // ReferenceTablesApi service type
 type ReferenceTablesApi datadog.Service
 
+// BatchRowsQuery Batch rows query.
+// Batch query reference table rows by their primary key values.  Returns only found rows in the included array.
+func (a *ReferenceTablesApi) BatchRowsQuery(ctx _context.Context, body BatchRowsQueryRequest) (BatchRowsQueryResponse, *_nethttp.Response, error) {
+	var (
+		localVarHTTPMethod  = _nethttp.MethodPost
+		localVarPostBody    interface{}
+		localVarReturnValue BatchRowsQueryResponse
+	)
+
+	localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.ReferenceTablesApi.BatchRowsQuery")
+	if err != nil {
+		return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
+	}
+
+	localVarPath := localBasePath + "/api/v2/reference-tables/queries/batch-rows"
+
+	localVarHeaderParams := make(map[string]string)
+	localVarQueryParams := _neturl.Values{}
+	localVarFormParams := _neturl.Values{}
+	localVarHeaderParams["Content-Type"] = "application/json"
+	localVarHeaderParams["Accept"] = "application/json"
+
+	// body params
+	localVarPostBody = &body
+	if a.Client.Cfg.DelegatedTokenConfig != nil {
+		err = datadog.UseDelegatedTokenAuth(ctx, &localVarHeaderParams, a.Client.Cfg.DelegatedTokenConfig)
+		if err != nil {
+			return localVarReturnValue, nil, err
+		}
+	} else {
+		datadog.SetAuthKeys(
+			ctx,
+			&localVarHeaderParams,
+			[2]string{"apiKeyAuth", "DD-API-KEY"},
+			[2]string{"appKeyAuth", "DD-APPLICATION-KEY"},
+		)
+	}
+	req, err := a.Client.PrepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, nil)
+	if err != nil {
+		return localVarReturnValue, nil, err
+	}
+
+	localVarHTTPResponse, err := a.Client.CallAPI(req)
+	if err != nil || localVarHTTPResponse == nil {
+		return localVarReturnValue, localVarHTTPResponse, err
+	}
+
+	localVarBody, err := datadog.ReadBody(localVarHTTPResponse)
+	if err != nil {
+		return localVarReturnValue, localVarHTTPResponse, err
+	}
+
+	if localVarHTTPResponse.StatusCode >= 300 {
+		newErr := datadog.GenericOpenAPIError{
+			ErrorBody:    localVarBody,
+			ErrorMessage: localVarHTTPResponse.Status,
+		}
+		if localVarHTTPResponse.StatusCode == 400 || localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 404 || localVarHTTPResponse.StatusCode == 429 || localVarHTTPResponse.StatusCode == 500 {
+			var v APIErrorResponse
+			err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
+			if err != nil {
+				return localVarReturnValue, localVarHTTPResponse, newErr
+			}
+			newErr.ErrorModel = v
+		}
+		return localVarReturnValue, localVarHTTPResponse, newErr
+	}
+
+	err = a.Client.Decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
+	if err != nil {
+		newErr := datadog.GenericOpenAPIError{
+			ErrorBody:    localVarBody,
+			ErrorMessage: err.Error(),
+		}
+		return localVarReturnValue, localVarHTTPResponse, newErr
+	}
+
+	return localVarReturnValue, localVarHTTPResponse, nil
+}
+
 // CreateReferenceTable Create reference table.
 // Creates a reference table. You can provide data in two ways:
 //  1. Call POST /api/v2/reference-tables/upload to get an upload ID. Then, PUT the CSV data

api/datadogV2/doc.go

@@ -578,6 +578,7 @@
 //   - [RUMApi.ListRUMEvents]
 //   - [RUMApi.SearchRUMEvents]
 //   - [RUMApi.UpdateRUMApplication]
+//   - [ReferenceTablesApi.BatchRowsQuery]
 //   - [ReferenceTablesApi.CreateReferenceTable]
 //   - [ReferenceTablesApi.CreateReferenceTableUpload]
 //   - [ReferenceTablesApi.DeleteRows]

api/datadogV2/model_batch_delete_rows_request_array.go

@@ -13,7 +13,7 @@ import (
 // BatchDeleteRowsRequestArray The request body for deleting multiple rows from a reference table.
 type BatchDeleteRowsRequestArray struct {
 	//
-	Data []BatchDeleteRowsRequestData `json:"data"`
+	Data []TableRowResourceIdentifier `json:"data"`
 	// 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 BatchDeleteRowsRequestArray 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 NewBatchDeleteRowsRequestArray(data []BatchDeleteRowsRequestData) *BatchDeleteRowsRequestArray {
+func NewBatchDeleteRowsRequestArray(data []TableRowResourceIdentifier) *BatchDeleteRowsRequestArray {
 	this := BatchDeleteRowsRequestArray{}
 	this.Data = data
 	return &this
@@ -38,25 +38,25 @@ func NewBatchDeleteRowsRequestArrayWithDefaults() *BatchDeleteRowsRequestArray {
 }
 
 // GetData returns the Data field value.
-func (o *BatchDeleteRowsRequestArray) GetData() []BatchDeleteRowsRequestData {
+func (o *BatchDeleteRowsRequestArray) GetData() []TableRowResourceIdentifier {
 	if o == nil {
-		var ret []BatchDeleteRowsRequestData
+		var ret []TableRowResourceIdentifier
 		return ret
 	}
 	return o.Data
 }
 
 // GetDataOk returns a tuple with the Data field value
 // and a boolean to check if the value has been set.
-func (o *BatchDeleteRowsRequestArray) GetDataOk() (*[]BatchDeleteRowsRequestData, bool) {
+func (o *BatchDeleteRowsRequestArray) GetDataOk() (*[]TableRowResourceIdentifier, bool) {
 	if o == nil {
 		return nil, false
 	}
 	return &o.Data, true
 }
 
 // SetData sets field value.
-func (o *BatchDeleteRowsRequestArray) SetData(v []BatchDeleteRowsRequestData) {
+func (o *BatchDeleteRowsRequestArray) SetData(v []TableRowResourceIdentifier) {
 	o.Data = v
 }
 
@@ -77,7 +77,7 @@ func (o BatchDeleteRowsRequestArray) MarshalJSON() ([]byte, error) {
 // UnmarshalJSON deserializes the given payload.
 func (o *BatchDeleteRowsRequestArray) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		Data *[]BatchDeleteRowsRequestData `json:"data"`
+		Data *[]TableRowResourceIdentifier `json:"data"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)

api/datadogV2/model_batch_rows_query_data_type.go

@@ -0,0 +1,64 @@
+// 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 (
+	"fmt"
+
+	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
+)
+
+// BatchRowsQueryDataType Resource type identifier for batch queries of reference table rows.
+type BatchRowsQueryDataType string
+
+// List of BatchRowsQueryDataType.
+const (
+	BATCHROWSQUERYDATATYPE_REFERENCE_TABLES_BATCH_ROWS_QUERY BatchRowsQueryDataType = "reference-tables-batch-rows-query"
+)
+
+var allowedBatchRowsQueryDataTypeEnumValues = []BatchRowsQueryDataType{
+	BATCHROWSQUERYDATATYPE_REFERENCE_TABLES_BATCH_ROWS_QUERY,
+}
+
+// GetAllowedValues reeturns the list of possible values.
+func (v *BatchRowsQueryDataType) GetAllowedValues() []BatchRowsQueryDataType {
+	return allowedBatchRowsQueryDataTypeEnumValues
+}
+
+// UnmarshalJSON deserializes the given payload.
+func (v *BatchRowsQueryDataType) UnmarshalJSON(src []byte) error {
+	var value string
+	err := datadog.Unmarshal(src, &value)
+	if err != nil {
+		return err
+	}
+	*v = BatchRowsQueryDataType(value)
+	return nil
+}
+
+// NewBatchRowsQueryDataTypeFromValue returns a pointer to a valid BatchRowsQueryDataType
+// for the value passed as argument, or an error if the value passed is not allowed by the enum.
+func NewBatchRowsQueryDataTypeFromValue(v string) (*BatchRowsQueryDataType, error) {
+	ev := BatchRowsQueryDataType(v)
+	if ev.IsValid() {
+		return &ev, nil
+	}
+	return nil, fmt.Errorf("invalid value '%v' for BatchRowsQueryDataType: valid values are %v", v, allowedBatchRowsQueryDataTypeEnumValues)
+}
+
+// IsValid return true if the value is valid for the enum, false otherwise.
+func (v BatchRowsQueryDataType) IsValid() bool {
+	for _, existing := range allowedBatchRowsQueryDataTypeEnumValues {
+		if existing == v {
+			return true
+		}
+	}
+	return false
+}
+
+// Ptr returns reference to BatchRowsQueryDataType value.
+func (v BatchRowsQueryDataType) Ptr() *BatchRowsQueryDataType {
+	return &v
+}