Add Datasets API to Open API Spec (#2503)

* updated review context

* no immutable

* Regenerate client from commit 36ebfd8 of spec repo

---------

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

Author: 3 people

.generated-info

@@ -0,0 +1,4 @@
+{
+  "spec_repo_commit": "36ebfd8",
+  "generated": "2025-07-14 17:54:40.252"
+}

.generator/schemas/v2/openapi.yaml

@@ -288,6 +288,14 @@ components:
       required: true
       schema:
         type: string
+    DatasetID:
+      description: The ID of a defined dataset.
+      example: 0879ce27-29a1-481f-a12e-bc2a48ec9ae1
+      in: path
+      name: dataset_id
+      required: true
+      schema:
+        type: string
     EntityID:
       description: UUID or Entity Ref.
       in: path
@@ -12178,6 +12186,85 @@ components:
       required:
       - databaseMonitoringTrigger
       type: object
+    Dataset:
+      description: Dataset object.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/DatasetAttributes'
+        id:
+          description: Unique identifier for the dataset.
+          example: 123e4567-e89b-12d3-a456-426614174000
+          type: string
+        type:
+          description: Resource type, always "dataset".
+          example: dataset
+          type: string
+      required:
+      - type
+      - attributes
+      type: object
+    DatasetAttributes:
+      description: Dataset metadata and configuration(s).
+      properties:
+        created_at:
+          description: Timestamp when the dataset was created.
+          format: date-time
+          nullable: true
+          type: string
+        created_by:
+          description: Unique ID of the user who created the dataset.
+          format: uuid
+          type: string
+        name:
+          description: Name of the dataset.
+          example: Security Audit Dataset
+          type: string
+        principals:
+          description: List of access principals, formatted as `principal_type:id`.
+            Principal can be 'team' or 'role'.
+          example:
+          - role:86245fce-0a4e-11f0-92bd-da7ad0900002
+          items:
+            example: role:86245fce-0a4e-11f0-92bd-da7ad0900002
+            type: string
+          type: array
+        product_filters:
+          description: List of product-specific filters.
+          items:
+            $ref: '#/components/schemas/FiltersPerProduct'
+          type: array
+      required:
+      - name
+      - product_filters
+      - principals
+      type: object
+    DatasetCreateRequest:
+      description: Create request for a dataset.
+      properties:
+        data:
+          $ref: '#/components/schemas/Dataset'
+      required:
+      - data
+      type: object
+    DatasetResponseMulti:
+      description: Response containing a list of datasets.
+      properties:
+        data:
+          description: The list of datasets returned in response.
+          items:
+            $ref: '#/components/schemas/Dataset'
+          type: array
+      required:
+      - data
+      type: object
+    DatasetResponseSingle:
+      description: Response containing a single dataset object.
+      properties:
+        data:
+          $ref: '#/components/schemas/Dataset'
+      required:
+      - data
+      type: object
     Date:
       description: Date as Unix timestamp in milliseconds.
       example: 1722439510282
@@ -15636,6 +15723,38 @@ components:
             $ref: '#/components/schemas/FastlyServiceData'
           type: array
       type: object
+    FiltersPerProduct:
+      description: Product-specific filters for the dataset.
+      properties:
+        filters:
+          description: 'Defines the list of tag-based filters used to restrict access
+            to telemetry data for a specific product.
+
+            These filters act as access control rules. Each filter must follow the
+            tag query syntax used by
+
+            Datadog (such as `@tag.key:value`), and only one tag or attribute may
+            be used to define the access strategy
+
+            per telemetry type.'
+          example:
+          - '@application.id:ABCD'
+          items:
+            example: '@application.id:ABCD'
+            type: string
+          type: array
+        product:
+          description: 'Name of the product the dataset is for. Possible values are
+            ''apm'', ''rum'', ''synthetics'',
+
+            ''metrics'', ''logs'', ''sd_repoinfo'', ''error_tracking'', ''cloud_cost'',
+            and ''ml_obs''.'
+          example: logs
+          type: string
+      required:
+      - product
+      - filters
+      type: object
     Finding:
       description: A single finding without the message and resource configuration.
       properties:
@@ -47544,6 +47663,135 @@ paths:
       tags:
       - Dashboard Lists
       x-codegen-request-body-name: body
+  /api/v2/datasets:
+    get:
+      description: Get all datasets that have been configured for an organization.
+      operationId: GetAllDatasets
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DatasetResponseMulti'
+          description: OK
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ: []
+      summary: Get all datasets
+      tags:
+      - Datasets
+      x-permission:
+        operator: OPEN
+        permissions: []
+    post:
+      description: Create a dataset with the configurations in the request.
+      operationId: CreateDataset
+      requestBody:
+        content:
+          application/json:
+            example:
+              data:
+                attributes:
+                  name: Test RUM Dataset
+                  principals:
+                  - role:23bacb30-1c59-11f0-a596-da7ad0900002
+                  product_filters:
+                  - filters:
+                    - '@application.id:application_123'
+                    product: rum
+                type: dataset
+            schema:
+              $ref: '#/components/schemas/DatasetCreateRequest'
+        description: Dataset payload
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DatasetResponseSingle'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '409':
+          $ref: '#/components/responses/ConflictResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ: []
+      summary: Create a dataset
+      tags:
+      - Datasets
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: OPEN
+        permissions: []
+  /api/v2/datasets/{dataset_id}:
+    delete:
+      description: Deletes the dataset associated with the ID.
+      operationId: DeleteDataset
+      parameters:
+      - $ref: '#/components/parameters/DatasetID'
+      responses:
+        '204':
+          description: No Content
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ: []
+      summary: Delete a dataset
+      tags:
+      - Datasets
+      x-permission:
+        operator: OPEN
+        permissions: []
+    get:
+      description: Retrieves the dataset associated with the ID.
+      operationId: GetDataset
+      parameters:
+      - $ref: '#/components/parameters/DatasetID'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DatasetResponseSingle'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ: []
+      summary: Get a single dataset by ID
+      tags:
+      - Datasets
+      x-permission:
+        operator: OPEN
+        permissions: []
   /api/v2/deletion/data/{product}:
     post:
       description: Creates a data deletion request by providing a query and a timeframe
@@ -65102,6 +65350,14 @@ tags:
     the allowed products. It's currently enabled for Logs and RUM and depends on `logs_delete_data`
     and `rum_delete_data` permissions respectively.
   name: Data Deletion
+- description: 'Data Access Controls in Datadog is a feature that allows administrators
+    and access managers to regulate
+
+    access to sensitive data. By defining Restricted Datasets, you can ensure that
+    only specific teams or roles can
+
+    view certain types of telemetry (for example, logs, traces, metrics, and RUM data).'
+  name: Datasets
 - description: 'Configure your Datadog Email Domain Allowlist directly through the
     Datadog API.
 

.github/workflows/approval_status.yml

@@ -0,0 +1,44 @@
+name: Send PR Approval Status
+
+permissions:
+  contents: read
+  pull-requests: write
+
+on:
+  pull_request:
+    branches:
+      - v2
+    types: ["review_requested", "synchronize", "opened", "reopened"]
+  pull_request_review:
+    types:
+      - submitted
+      - dismissed
+
+jobs:
+  send_status:
+    runs-on: ubuntu-latest
+    if: >
+      github.event.pull_request.draft == false &&
+      !contains(github.event.pull_request.labels.*.name, 'ci/skip') &&
+      !contains(github.event.pull_request.head.ref, 'datadog-api-spec/v2/test/') &&
+      contains(github.event.pull_request.head.ref, 'datadog-api-spec/v2/generated')
+    steps:
+      - name: Get GitHub App token
+        id: get_token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.PIPELINE_GITHUB_APP_ID }}
+          private-key: ${{ secrets.PIPELINE_GITHUB_APP_PRIVATE_KEY }}
+          repositories: datadog-api-spec
+      - name: Get pull request number
+        id: get_pr_number
+        run: |
+          spec_pr=$(echo "${{ github.event.pull_request.head.ref }}" | sed 's/.*generated\/\([0-9]*\).*/\1/')
+          echo "spec_pr=${spec_pr}" >> $GITHUB_OUTPUT
+      - name: Post PR review status check
+        uses: DataDog/github-actions/post-review-status@65b4875f33ad773d7ba4b005a2cb5f35020295f3
+        with:
+          github-token: ${{ steps.get_token.outputs.token }}
+          repo: datadog-api-spec
+          context: datadog-api-client-typescript/v2
+          pull-request: ${{ steps.get_pr_number.outputs.spec_pr }}

.pre-commit-config.yaml

@@ -9,14 +9,14 @@ repos:
       - id: lint
         name: Lint
         language: node
-        entry: bash -c "COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack enable && yarn install && yarn lint:fix"
+        entry: bash -c "COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack enable && yarn install --no-immutable && yarn lint:fix"
         stages: [manual]
         pass_filenames: false
         language_version: "22.15.0"
       - id: format
         name: Format code
         language: node
-        entry: bash -c "COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack enable && yarn install && yarn format"
+        entry: bash -c "COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack enable && yarn install --no-immutable && yarn format"
         stages: [manual]
         pass_filenames: false
         language_version: "22.15.0"