Skip to content

Commit c816a01

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Split Dataset into separate request and response objects, mark unstable (#2584)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent ceee9bd commit c816a01

File tree

44 files changed

+1595
-138
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1595
-138
lines changed

‎.generated-info

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"spec_repo_commit": "ab8171f",
3-
"generated": "2025-07-31 17:34:54.078"
2+
"spec_repo_commit": "672a533",
3+
"generated": "2025-07-31 18:08:57.015"
44
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 84 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -13145,31 +13145,33 @@ components:
1314513145
required:
1314613146
- type
1314713147
type: object
13148-
Dataset:
13149-
description: "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per
13150-
Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value
13151-
pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one
13152-
tag key or attribute may be used to define access within a single telemetry
13153-
type.\n - The same or different tag key may be used across different telemetry
13154-
types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within
13155-
a single dataset.\n - A tag value used in one dataset cannot be reused in
13156-
another dataset of the same telemetry type."
13148+
DatasetAttributesRequest:
13149+
description: Dataset metadata and configurations.
1315713150
properties:
13158-
attributes:
13159-
$ref: '#/components/schemas/DatasetAttributes'
13160-
id:
13161-
description: Unique identifier for the dataset.
13162-
example: 123e4567-e89b-12d3-a456-426614174000
13163-
type: string
13164-
type:
13165-
description: Resource type, always "dataset".
13166-
example: dataset
13151+
name:
13152+
description: Name of the dataset.
13153+
example: Security Audit Dataset
1316713154
type: string
13155+
principals:
13156+
description: List of access principals, formatted as `principal_type:id`.
13157+
Principal can be 'team' or 'role'.
13158+
example:
13159+
- role:94172442-be03-11e9-a77a-3b7612558ac1
13160+
items:
13161+
example: role:94172442-be03-11e9-a77a-3b7612558ac1
13162+
type: string
13163+
type: array
13164+
product_filters:
13165+
description: List of product-specific filters.
13166+
items:
13167+
$ref: '#/components/schemas/FiltersPerProduct'
13168+
type: array
1316813169
required:
13169-
- type
13170-
- attributes
13170+
- name
13171+
- product_filters
13172+
- principals
1317113173
type: object
13172-
DatasetAttributes:
13174+
DatasetAttributesResponse:
1317313175
description: Dataset metadata and configuration(s).
1317413176
properties:
1317513177
created_at:
@@ -13199,43 +13201,76 @@ components:
1319913201
items:
1320013202
$ref: '#/components/schemas/FiltersPerProduct'
1320113203
type: array
13202-
required:
13203-
- name
13204-
- product_filters
13205-
- principals
1320613204
type: object
1320713205
DatasetCreateRequest:
1320813206
description: Create request for a dataset.
1320913207
properties:
1321013208
data:
13211-
$ref: '#/components/schemas/Dataset'
13209+
$ref: '#/components/schemas/DatasetRequest'
1321213210
required:
1321313211
- data
1321413212
type: object
13213+
DatasetRequest:
13214+
description: "**Datasets Object Constraints**\n- **Tag limit per dataset**:\n
13215+
\ - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n-
13216+
**Tag key rules per telemetry type**:\n - Only one tag key or attribute may
13217+
be used to define access within a single telemetry type.\n - The same or
13218+
different tag key may be used across different telemetry types.\n\n- **Tag
13219+
value uniqueness**:\n - Tag values must be unique within a single dataset.\n
13220+
\ - A tag value used in one dataset cannot be reused in another dataset of
13221+
the same telemetry type."
13222+
properties:
13223+
attributes:
13224+
$ref: '#/components/schemas/DatasetAttributesRequest'
13225+
type:
13226+
description: Resource type, always "dataset".
13227+
example: dataset
13228+
type: string
13229+
required:
13230+
- type
13231+
- attributes
13232+
type: object
13233+
DatasetResponse:
13234+
description: "**Datasets Object Constraints**\n- **Tag Limit per Dataset**:\n
13235+
\ - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n-
13236+
**Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may
13237+
be used to define access within a single telemetry type.\n - The same or
13238+
different tag key may be used across different telemetry types.\n\n- **Tag
13239+
Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n
13240+
\ - A tag value used in one dataset cannot be reused in another dataset of
13241+
the same telemetry type."
13242+
properties:
13243+
attributes:
13244+
$ref: '#/components/schemas/DatasetAttributesResponse'
13245+
id:
13246+
description: Unique identifier for the dataset.
13247+
example: 123e4567-e89b-12d3-a456-426614174000
13248+
type: string
13249+
type:
13250+
description: Resource type, always "dataset".
13251+
example: dataset
13252+
type: string
13253+
type: object
1321513254
DatasetResponseMulti:
1321613255
description: Response containing a list of datasets.
1321713256
properties:
1321813257
data:
1321913258
description: The list of datasets returned in response.
1322013259
items:
13221-
$ref: '#/components/schemas/Dataset'
13260+
$ref: '#/components/schemas/DatasetResponse'
1322213261
type: array
13223-
required:
13224-
- data
1322513262
type: object
1322613263
DatasetResponseSingle:
1322713264
description: Response containing a single dataset object.
1322813265
properties:
1322913266
data:
13230-
$ref: '#/components/schemas/Dataset'
13231-
required:
13232-
- data
13267+
$ref: '#/components/schemas/DatasetResponse'
1323313268
type: object
1323413269
DatasetUpdateRequest:
1323513270
description: Edit request for a dataset.
1323613271
properties:
1323713272
data:
13238-
$ref: '#/components/schemas/Dataset'
13273+
$ref: '#/components/schemas/DatasetRequest'
1323913274
required:
1324013275
- data
1324113276
type: object
@@ -49913,6 +49948,9 @@ paths:
4991349948
operator: OR
4991449949
permissions:
4991549950
- user_access_read
49951+
x-unstable: '**Note: Data Access is in preview. If you have any feedback,
49952+
49953+
contact [Datadog support](https://docs.datadoghq.com/help/).**'
4991649954
post:
4991749955
description: Create a dataset with the configurations in the request.
4991849956
operationId: CreateDataset
@@ -49924,7 +49962,7 @@ paths:
4992449962
attributes:
4992549963
name: Test RUM Dataset
4992649964
principals:
49927-
- role:23bacb30-1c59-11f0-a596-da7ad0900002
49965+
- role:94172442-be03-11e9-a77a-3b7612558ac1
4992849966
product_filters:
4992949967
- filters:
4993049968
- '@application.id:application_123'
@@ -49962,6 +50000,9 @@ paths:
4996250000
operator: OR
4996350001
permissions:
4996450002
- user_access_manage
50003+
x-unstable: '**Note: Data Access is in preview. If you have any feedback,
50004+
50005+
contact [Datadog support](https://docs.datadoghq.com/help/).**'
4996550006
/api/v2/datasets/{dataset_id}:
4996650007
delete:
4996750008
description: Deletes the dataset associated with the ID.
@@ -49989,6 +50030,9 @@ paths:
4998950030
x-permission:
4999050031
operator: OPEN
4999150032
permissions: []
50033+
x-unstable: '**Note: Data Access is in preview. If you have any feedback,
50034+
50035+
contact [Datadog support](https://docs.datadoghq.com/help/).**'
4999250036
get:
4999350037
description: Retrieves the dataset associated with the ID.
4999450038
operationId: GetDataset
@@ -50019,6 +50063,9 @@ paths:
5001950063
x-permission:
5002050064
operator: OPEN
5002150065
permissions: []
50066+
x-unstable: '**Note: Data Access is in preview. If you have any feedback,
50067+
50068+
contact [Datadog support](https://docs.datadoghq.com/help/).**'
5002250069
put:
5002350070
description: Edits the dataset associated with the ID.
5002450071
operationId: UpdateDataset
@@ -50057,6 +50104,9 @@ paths:
5005750104
x-permission:
5005850105
operator: OPEN
5005950106
permissions: []
50107+
x-unstable: '**Note: Data Access is in preview. If you have any feedback,
50108+
50109+
contact [Datadog support](https://docs.datadoghq.com/help/).**'
5006050110
/api/v2/deletion/data/{product}:
5006150111
post:
5006250112
description: Creates a data deletion request by providing a query and a timeframe

‎cassettes/v2/Datasets_304632144/Create-a-dataset-returns-Bad-Request-response_430521186/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2025-07-29T20:35:57.144Z"

‎cassettes/v2/Datasets_304632144/Create-a-dataset-returns-Bad-Request-response_430521186/recording.har

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{
2+
"log": {
3+
"_recordingName": "Datasets/Create a dataset returns \"Bad Request\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "15dba2ce708ff0e12a5fcc843f353d7d",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 22,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
},
23+
{
24+
"_fromType": "array",
25+
"name": "content-type",
26+
"value": "application/json"
27+
}
28+
],
29+
"headersSize": 555,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "POST",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"test\":\"bad_request\"}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v2/datasets"
39+
},
40+
"response": {
41+
"bodySize": 66,
42+
"content": {
43+
"mimeType": "application/json",
44+
"size": 66,
45+
"text": "{\"errors\":[\"Invalid request: Request body contains invalid json\"]}"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/json"
52+
}
53+
],
54+
"headersSize": 677,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 400,
58+
"statusText": "Bad Request"
59+
},
60+
"startedDateTime": "2025-07-29T20:35:57.148Z",
61+
"time": 169
62+
}
63+
],
64+
"pages": [],
65+
"version": "1.2"
66+
}
67+
}

‎cassettes/v2/Datasets_304632144/Create-a-dataset-returns-Conflict-response_2550608988/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2025-07-29T20:35:57.324Z"

0 commit comments

Comments
 (0)