Skip to content

Commit f558ef3

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Split Dataset into separate request and response objects, mark unstable (DataDog#3249)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 02fc6a5 commit f558ef3

42 files changed

Lines changed: 1241 additions & 297 deletions

File tree

Some content is hidden

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

.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:35:13.885"
2+
"spec_repo_commit": "672a533",
3+
"generated": "2025-07-31 18:09:12.434"
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

api/datadog/configuration.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -619,6 +619,11 @@ func NewConfiguration() *Configuration {
619619
"v2.ListVulnerableAssets": false,
620620
"v2.MuteFindings": false,
621621
"v2.RunHistoricalJob": false,
622+
"v2.CreateDataset": false,
623+
"v2.DeleteDataset": false,
624+
"v2.GetAllDatasets": false,
625+
"v2.GetDataset": false,
626+
"v2.UpdateDataset": false,
622627
"v2.CancelDataDeletionRequest": false,
623628
"v2.CreateDataDeletionRequest": false,
624629
"v2.GetDataDeletionRequests": false,

api/datadogV2/api_datasets.go

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ package datadogV2
66

77
import (
88
_context "context"
9+
_fmt "fmt"
10+
_log "log"
911
_nethttp "net/http"
1012
_neturl "net/url"
1113

@@ -24,6 +26,15 @@ func (a *DatasetsApi) CreateDataset(ctx _context.Context, body DatasetCreateRequ
2426
localVarReturnValue DatasetResponseSingle
2527
)
2628

29+
operationId := "v2.CreateDataset"
30+
isOperationEnabled := a.Client.Cfg.IsUnstableOperationEnabled(operationId)
31+
if !isOperationEnabled {
32+
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: _fmt.Sprintf("Unstable operation '%s' is disabled", operationId)}
33+
}
34+
if isOperationEnabled && a.Client.Cfg.Debug {
35+
_log.Printf("WARNING: Using unstable operation '%s'", operationId)
36+
}
37+
2738
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.DatasetsApi.CreateDataset")
2839
if err != nil {
2940
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
@@ -103,6 +114,15 @@ func (a *DatasetsApi) DeleteDataset(ctx _context.Context, datasetId string) (*_n
103114
localVarPostBody interface{}
104115
)
105116

117+
operationId := "v2.DeleteDataset"
118+
isOperationEnabled := a.Client.Cfg.IsUnstableOperationEnabled(operationId)
119+
if !isOperationEnabled {
120+
return nil, datadog.GenericOpenAPIError{ErrorMessage: _fmt.Sprintf("Unstable operation '%s' is disabled", operationId)}
121+
}
122+
if isOperationEnabled && a.Client.Cfg.Debug {
123+
_log.Printf("WARNING: Using unstable operation '%s'", operationId)
124+
}
125+
106126
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.DatasetsApi.DeleteDataset")
107127
if err != nil {
108128
return nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
@@ -172,6 +192,15 @@ func (a *DatasetsApi) GetAllDatasets(ctx _context.Context) (DatasetResponseMulti
172192
localVarReturnValue DatasetResponseMulti
173193
)
174194

195+
operationId := "v2.GetAllDatasets"
196+
isOperationEnabled := a.Client.Cfg.IsUnstableOperationEnabled(operationId)
197+
if !isOperationEnabled {
198+
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: _fmt.Sprintf("Unstable operation '%s' is disabled", operationId)}
199+
}
200+
if isOperationEnabled && a.Client.Cfg.Debug {
201+
_log.Printf("WARNING: Using unstable operation '%s'", operationId)
202+
}
203+
175204
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.DatasetsApi.GetAllDatasets")
176205
if err != nil {
177206
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
@@ -249,6 +278,15 @@ func (a *DatasetsApi) GetDataset(ctx _context.Context, datasetId string) (Datase
249278
localVarReturnValue DatasetResponseSingle
250279
)
251280

281+
operationId := "v2.GetDataset"
282+
isOperationEnabled := a.Client.Cfg.IsUnstableOperationEnabled(operationId)
283+
if !isOperationEnabled {
284+
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: _fmt.Sprintf("Unstable operation '%s' is disabled", operationId)}
285+
}
286+
if isOperationEnabled && a.Client.Cfg.Debug {
287+
_log.Printf("WARNING: Using unstable operation '%s'", operationId)
288+
}
289+
252290
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.DatasetsApi.GetDataset")
253291
if err != nil {
254292
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
@@ -327,6 +365,15 @@ func (a *DatasetsApi) UpdateDataset(ctx _context.Context, datasetId string, body
327365
localVarReturnValue DatasetResponseSingle
328366
)
329367

368+
operationId := "v2.UpdateDataset"
369+
isOperationEnabled := a.Client.Cfg.IsUnstableOperationEnabled(operationId)
370+
if !isOperationEnabled {
371+
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: _fmt.Sprintf("Unstable operation '%s' is disabled", operationId)}
372+
}
373+
if isOperationEnabled && a.Client.Cfg.Debug {
374+
_log.Printf("WARNING: Using unstable operation '%s'", operationId)
375+
}
376+
330377
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.DatasetsApi.UpdateDataset")
331378
if err != nil {
332379
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}

0 commit comments

Comments
 (0)