Skip to content

Commit 6b8490f

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add enum Dataset type to Dataset API spec (#2766)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 22e917a commit 6b8490f

File tree

9 files changed

+73
-18
lines changed

9 files changed

+73
-18
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": "c38287b",
3-
"generated": "2025-08-15 18:53:53.664"
2+
"spec_repo_commit": "7851858",
3+
"generated": "2025-08-18 14:47:48.100"
44
}

.generator/schemas/v2/openapi.yaml

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13258,9 +13258,7 @@ components:
1325813258
attributes:
1325913259
$ref: '#/components/schemas/DatasetAttributesRequest'
1326013260
type:
13261-
description: Resource type, always "dataset".
13262-
example: dataset
13263-
type: string
13261+
$ref: '#/components/schemas/DatasetType'
1326413262
required:
1326513263
- type
1326613264
- attributes
@@ -13282,9 +13280,7 @@ components:
1328213280
example: 123e4567-e89b-12d3-a456-426614174000
1328313281
type: string
1328413282
type:
13285-
description: Resource type, always "dataset".
13286-
example: dataset
13287-
type: string
13283+
$ref: '#/components/schemas/DatasetType'
1328813284
type: object
1328913285
DatasetResponseMulti:
1329013286
description: Response containing a list of datasets.
@@ -13301,6 +13297,15 @@ components:
1330113297
data:
1330213298
$ref: '#/components/schemas/DatasetResponse'
1330313299
type: object
13300+
DatasetType:
13301+
default: dataset
13302+
description: Resource type, always set to `dataset`.
13303+
enum:
13304+
- dataset
13305+
example: dataset
13306+
type: string
13307+
x-enum-varnames:
13308+
- DATASET
1330413309
DatasetUpdateRequest:
1330513310
description: Edit request for a dataset.
1330613311
properties:

docs/datadog_api_client.v2.model.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5310,6 +5310,13 @@ datadog\_api\_client.v2.model.dataset\_response\_single module
53105310
:members:
53115311
:show-inheritance:
53125312

5313+
datadog\_api\_client.v2.model.dataset\_type module
5314+
--------------------------------------------------
5315+
5316+
.. automodule:: datadog_api_client.v2.model.dataset_type
5317+
:members:
5318+
:show-inheritance:
5319+
53135320
datadog\_api\_client.v2.model.dataset\_update\_request module
53145321
-------------------------------------------------------------
53155322

examples/v2/datasets/CreateDataset.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
from datadog_api_client.v2.model.dataset_attributes_request import DatasetAttributesRequest
88
from datadog_api_client.v2.model.dataset_create_request import DatasetCreateRequest
99
from datadog_api_client.v2.model.dataset_request import DatasetRequest
10+
from datadog_api_client.v2.model.dataset_type import DatasetType
1011
from datadog_api_client.v2.model.filters_per_product import FiltersPerProduct
1112

1213
body = DatasetCreateRequest(
@@ -25,7 +26,7 @@
2526
),
2627
],
2728
),
28-
type="dataset",
29+
type=DatasetType.DATASET,
2930
),
3031
)
3132

examples/v2/datasets/UpdateDataset.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
from datadog_api_client.v2.api.datasets_api import DatasetsApi
88
from datadog_api_client.v2.model.dataset_attributes_request import DatasetAttributesRequest
99
from datadog_api_client.v2.model.dataset_request import DatasetRequest
10+
from datadog_api_client.v2.model.dataset_type import DatasetType
1011
from datadog_api_client.v2.model.dataset_update_request import DatasetUpdateRequest
1112
from datadog_api_client.v2.model.filters_per_product import FiltersPerProduct
1213

@@ -29,7 +30,7 @@
2930
),
3031
],
3132
),
32-
type="dataset",
33+
type=DatasetType.DATASET,
3334
),
3435
)
3536

src/datadog_api_client/v2/model/dataset_request.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,26 @@
1313

1414
if TYPE_CHECKING:
1515
from datadog_api_client.v2.model.dataset_attributes_request import DatasetAttributesRequest
16+
from datadog_api_client.v2.model.dataset_type import DatasetType
1617

1718

1819
class DatasetRequest(ModelNormal):
1920
@cached_property
2021
def openapi_types(_):
2122
from datadog_api_client.v2.model.dataset_attributes_request import DatasetAttributesRequest
23+
from datadog_api_client.v2.model.dataset_type import DatasetType
2224

2325
return {
2426
"attributes": (DatasetAttributesRequest,),
25-
"type": (str,),
27+
"type": (DatasetType,),
2628
}
2729

2830
attribute_map = {
2931
"attributes": "attributes",
3032
"type": "type",
3133
}
3234

33-
def __init__(self_, attributes: DatasetAttributesRequest, type: str, **kwargs):
35+
def __init__(self_, attributes: DatasetAttributesRequest, type: DatasetType, **kwargs):
3436
"""
3537
**Datasets Object Constraints**
3638
@@ -54,8 +56,8 @@ def __init__(self_, attributes: DatasetAttributesRequest, type: str, **kwargs):
5456
:param attributes: Dataset metadata and configurations.
5557
:type attributes: DatasetAttributesRequest
5658
57-
:param type: Resource type, always "dataset".
58-
:type type: str
59+
:param type: Resource type, always set to ``dataset``.
60+
:type type: DatasetType
5961
"""
6062
super().__init__(kwargs)
6163

src/datadog_api_client/v2/model/dataset_response.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,19 @@
1515

1616
if TYPE_CHECKING:
1717
from datadog_api_client.v2.model.dataset_attributes_response import DatasetAttributesResponse
18+
from datadog_api_client.v2.model.dataset_type import DatasetType
1819

1920

2021
class DatasetResponse(ModelNormal):
2122
@cached_property
2223
def openapi_types(_):
2324
from datadog_api_client.v2.model.dataset_attributes_response import DatasetAttributesResponse
25+
from datadog_api_client.v2.model.dataset_type import DatasetType
2426

2527
return {
2628
"attributes": (DatasetAttributesResponse,),
2729
"id": (str,),
28-
"type": (str,),
30+
"type": (DatasetType,),
2931
}
3032

3133
attribute_map = {
@@ -38,7 +40,7 @@ def __init__(
3840
self_,
3941
attributes: Union[DatasetAttributesResponse, UnsetType] = unset,
4042
id: Union[str, UnsetType] = unset,
41-
type: Union[str, UnsetType] = unset,
43+
type: Union[DatasetType, UnsetType] = unset,
4244
**kwargs,
4345
):
4446
"""
@@ -67,8 +69,8 @@ def __init__(
6769
:param id: Unique identifier for the dataset.
6870
:type id: str, optional
6971
70-
:param type: Resource type, always "dataset".
71-
:type type: str, optional
72+
:param type: Resource type, always set to ``dataset``.
73+
:type type: DatasetType, optional
7274
"""
7375
if attributes is not unset:
7476
kwargs["attributes"] = attributes
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
7+
from datadog_api_client.model_utils import (
8+
ModelSimple,
9+
cached_property,
10+
)
11+
12+
from typing import ClassVar
13+
14+
15+
class DatasetType(ModelSimple):
16+
"""
17+
Resource type, always set to `dataset`.
18+
19+
:param value: If omitted defaults to "dataset". Must be one of ["dataset"].
20+
:type value: str
21+
"""
22+
23+
allowed_values = {
24+
"dataset",
25+
}
26+
DATASET: ClassVar["DatasetType"]
27+
28+
@cached_property
29+
def openapi_types(_):
30+
return {
31+
"value": (str,),
32+
}
33+
34+
35+
DatasetType.DATASET = DatasetType("dataset")

src/datadog_api_client/v2/models/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1048,6 +1048,7 @@
10481048
from datadog_api_client.v2.model.dataset_response import DatasetResponse
10491049
from datadog_api_client.v2.model.dataset_response_multi import DatasetResponseMulti
10501050
from datadog_api_client.v2.model.dataset_response_single import DatasetResponseSingle
1051+
from datadog_api_client.v2.model.dataset_type import DatasetType
10511052
from datadog_api_client.v2.model.dataset_update_request import DatasetUpdateRequest
10521053
from datadog_api_client.v2.model.delete_app_response import DeleteAppResponse
10531054
from datadog_api_client.v2.model.delete_app_response_data import DeleteAppResponseData
@@ -4716,6 +4717,7 @@
47164717
"DatasetResponse",
47174718
"DatasetResponseMulti",
47184719
"DatasetResponseSingle",
4720+
"DatasetType",
47194721
"DatasetUpdateRequest",
47204722
"DeleteAppResponse",
47214723
"DeleteAppResponseData",

0 commit comments

Comments
 (0)