Add Row Update Endpoints to Reference Tables API spec (#3021)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.generator/schemas/v2/openapi.yaml

@@ -6900,6 +6900,72 @@ components:
       required:
       - data
       type: object
+    BatchDeleteRowsRequestArray:
+      description: The request body for deleting multiple rows from a reference table.
+      properties:
+        data:
+          items:
+            $ref: '#/components/schemas/BatchDeleteRowsRequestData'
+          maxItems: 200
+          type: array
+      required:
+      - data
+      type: object
+    BatchDeleteRowsRequestData:
+      description: Row resource containing a single row identifier for deletion.
+      properties:
+        id:
+          example: primary_key_value
+          type: string
+        type:
+          $ref: '#/components/schemas/TableRowResourceDataType'
+      required:
+      - type
+      - id
+      type: object
+    BatchUpsertRowsRequestArray:
+      description: The request body for creating or updating multiple rows into a
+        reference table.
+      properties:
+        data:
+          items:
+            $ref: '#/components/schemas/BatchUpsertRowsRequestData'
+          maxItems: 200
+          type: array
+      required:
+      - data
+      type: object
+    BatchUpsertRowsRequestData:
+      description: Row resource containing a single row identifier and its column
+        values.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/BatchUpsertRowsRequestDataAttributes'
+        id:
+          example: primary_key_value
+          type: string
+        type:
+          $ref: '#/components/schemas/TableRowResourceDataType'
+      required:
+      - type
+      - id
+      type: object
+    BatchUpsertRowsRequestDataAttributes:
+      description: Attributes containing row data values for row creation or update
+        operations.
+      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
+          type: object
+      required:
+      - values
+      type: object
     BillConfig:
       description: Bill config.
       properties:
@@ -76823,6 +76889,47 @@ paths:
       tags:
       - Reference Tables
   /api/v2/reference-tables/tables/{id}/rows:
+    delete:
+      description: Delete multiple rows from a Reference Table by their primary key
+        values.
+      operationId: DeleteRows
+      parameters:
+      - description: Unique identifier of the reference table to delete rows from
+        in: path
+        name: id
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/BatchDeleteRowsRequestArray'
+        required: true
+      responses:
+        '200':
+          description: Rows deleted successfully
+        '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: Delete rows
+      tags:
+      - Reference Tables
     get:
       description: Get reference table rows by their primary key values.
       operationId: GetRowsByID
@@ -76867,6 +76974,48 @@ paths:
       summary: Get rows by id
       tags:
       - Reference Tables
+    post:
+      description: Create or update rows in a Reference Table by their primary key
+        values. If a row with the specified primary key exists, it is updated; otherwise,
+        a new row is created.
+      operationId: UpsertRows
+      parameters:
+      - description: Unique identifier of the reference table to upsert rows into
+        in: path
+        name: id
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/BatchUpsertRowsRequestArray'
+        required: true
+      responses:
+        '200':
+          description: Rows created or updated successfully
+        '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: Upsert rows
+      tags:
+      - Reference Tables
   /api/v2/reference-tables/uploads:
     post:
       description: Create a reference table upload for bulk data ingestion

examples/v2/reference-tables/DeleteRows.ts

@@ -0,0 +1,29 @@
+/**
+ * Delete rows returns "Rows deleted successfully" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.ReferenceTablesApi(configuration);
+
+const params: v2.ReferenceTablesApiDeleteRowsRequest = {
+  body: {
+    data: [
+      {
+        id: "primary_key_value",
+        type: "row",
+      },
+    ],
+  },
+  id: "id",
+};
+
+apiInstance
+  .deleteRows(params)
+  .then((data: any) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

examples/v2/reference-tables/UpsertRows.ts

@@ -0,0 +1,35 @@
+/**
+ * Upsert rows returns "Rows created or updated successfully" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.ReferenceTablesApi(configuration);
+
+const params: v2.ReferenceTablesApiUpsertRowsRequest = {
+  body: {
+    data: [
+      {
+        attributes: {
+          values: {
+            example_key_value: "primary_key_value",
+            name: "row_name",
+          },
+        },
+        id: "primary_key_value",
+        type: "row",
+      },
+    ],
+  },
+  id: "id",
+};
+
+apiInstance
+  .upsertRows(params)
+  .then((data: any) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/support/scenarios_model_mapping.ts

@@ -7973,6 +7973,28 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             },
         "operationResponseType": "TableRowResourceArray",
     },
+    "v2.UpsertRows": {
+        "id": {
+            "type": "string",
+            "format": "",
+            },
+        "body": {
+            "type": "BatchUpsertRowsRequestArray",
+            "format": "",
+            },
+        "operationResponseType": "{}",
+    },
+    "v2.DeleteRows": {
+        "id": {
+            "type": "string",
+            "format": "",
+            },
+        "body": {
+            "type": "BatchDeleteRowsRequestArray",
+            "format": "",
+            },
+        "operationResponseType": "{}",
+    },
     "v2.CreateReferenceTableUpload": {
         "body": {
             "type": "CreateUploadRequest",

features/v2/reference_tables.feature

@@ -53,6 +53,30 @@ Feature: Reference Tables
     When the request is sent
     Then the response status is 400 Bad Request
 
+  @generated @skip @team:DataDog/redapl-experiences
+  Scenario: Delete rows returns "Bad Request" response
+    Given new "DeleteRows" request
+    And request contains "id" parameter from "REPLACE.ME"
+    And body with value {"data": [{"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: Delete rows returns "Not Found" response
+    Given new "DeleteRows" request
+    And request contains "id" parameter from "REPLACE.ME"
+    And body with value {"data": [{"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: Delete rows returns "Rows deleted successfully" response
+    Given new "DeleteRows" request
+    And request contains "id" parameter from "REPLACE.ME"
+    And body with value {"data": [{"id": "primary_key_value", "type": "row"}]}
+    When the request is sent
+    Then the response status is 200 Rows deleted successfully
+
   @generated @skip @team:DataDog/redapl-experiences
   Scenario: Delete table returns "Not Found" response
     Given new "DeleteTable" request
@@ -119,3 +143,27 @@ Feature: Reference Tables
     And body with value {"data": {"attributes": {"description": "this is a cloud table generated via a cloud bucket sync", "file_metadata": {"access_details": {"aws_detail": {"aws_account_id": "test-account-id", "aws_bucket_name": "test-bucket", "file_path": "test_rt.csv"}}, "sync_enabled": true}, "schema": {"fields": [{"name": "id", "type": "INT32"}, {"name": "name", "type": "STRING"}], "primary_keys": ["id"]}, "sync_enabled": false, "tags": ["test_tag"]}, "type": "reference_table"}}
     When the request is sent
     Then the response status is 200 OK
+
+  @generated @skip @team:DataDog/redapl-experiences
+  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"}]}
+    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"}]}
+    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"}]}
+    When the request is sent
+    Then the response status is 200 Rows created or updated successfully

features/v2/undo.json

@@ -3174,12 +3174,26 @@
       "type": "idempotent"
     }
   },
+  "DeleteRows": {
+    "tag": "Reference Tables",
+    "undo": {
+      "type": "idempotent"
+    }
+  },
   "GetRowsByID": {
     "tag": "Reference Tables",
     "undo": {
       "type": "safe"
     }
   },
+  "UpsertRows": {
+    "tag": "Reference Tables",
+    "undo": {
+      "operationId": "DeleteRows",
+      "parameters": [],
+      "type": "unsafe"
+    }
+  },
   "CreateReferenceTableUpload": {
     "tag": "Reference Tables",
     "undo": {