Skip to content

Add enum Dataset type to Dataset API spec #2654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .generated-info
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"spec_repo_commit": "8001cbb",
"generated": "2025-08-13 20:27:09.207"
"spec_repo_commit": "78cfa5e",
"generated": "2025-08-15 13:54:10.191"
}
17 changes: 11 additions & 6 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13264,9 +13264,7 @@ components:
attributes:
$ref: '#/components/schemas/DatasetAttributesRequest'
type:
description: Resource type, always "dataset".
example: dataset
type: string
$ref: '#/components/schemas/DatasetType'
required:
- type
- attributes
Expand All @@ -13288,9 +13286,7 @@ components:
example: 123e4567-e89b-12d3-a456-426614174000
type: string
type:
description: Resource type, always "dataset".
example: dataset
type: string
$ref: '#/components/schemas/DatasetType'
type: object
DatasetResponseMulti:
description: Response containing a list of datasets.
Expand All @@ -13307,6 +13303,15 @@ components:
data:
$ref: '#/components/schemas/DatasetResponse'
type: object
DatasetType:
default: dataset
description: Resource type, always set to `dataset`.
enum:
- dataset
example: dataset
type: string
x-enum-varnames:
- DATASET
DatasetUpdateRequest:
description: Edit request for a dataset.
properties:
Expand Down
1 change: 1 addition & 0 deletions services/datasets/src/v2/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ export { DatasetRequest } from "./models/DatasetRequest";
export { DatasetResponse } from "./models/DatasetResponse";
export { DatasetResponseMulti } from "./models/DatasetResponseMulti";
export { DatasetResponseSingle } from "./models/DatasetResponseSingle";
export { DatasetType } from "./models/DatasetType";
export { DatasetUpdateRequest } from "./models/DatasetUpdateRequest";
export { FiltersPerProduct } from "./models/FiltersPerProduct";
7 changes: 4 additions & 3 deletions services/datasets/src/v2/models/DatasetRequest.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { AttributeTypeMap } from "@datadog/datadog-api-client";

import { DatasetAttributesRequest } from "./DatasetAttributesRequest";
import { DatasetType } from "./DatasetType";

/**
* **Datasets Object Constraints**
Expand All @@ -21,9 +22,9 @@ export class DatasetRequest {
*/
"attributes": DatasetAttributesRequest;
/**
* Resource type, always "dataset".
* Resource type, always set to `dataset`.
*/
"type": string;
"type": DatasetType;
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
Expand All @@ -46,7 +47,7 @@ export class DatasetRequest {
},
type: {
baseName: "type",
type: "string",
type: "DatasetType",
required: true,
},
additionalProperties: {
Expand Down
7 changes: 4 additions & 3 deletions services/datasets/src/v2/models/DatasetResponse.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { AttributeTypeMap } from "@datadog/datadog-api-client";

import { DatasetAttributesResponse } from "./DatasetAttributesResponse";
import { DatasetType } from "./DatasetType";

/**
* **Datasets Object Constraints**
Expand All @@ -25,9 +26,9 @@ export class DatasetResponse {
*/
"id"?: string;
/**
* Resource type, always "dataset".
* Resource type, always set to `dataset`.
*/
"type"?: string;
"type"?: DatasetType;
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
Expand All @@ -53,7 +54,7 @@ export class DatasetResponse {
},
type: {
baseName: "type",
type: "string",
type: "DatasetType",
},
additionalProperties: {
baseName: "additionalProperties",
Expand Down
7 changes: 7 additions & 0 deletions services/datasets/src/v2/models/DatasetType.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { UnparsedObject } from "@datadog/datadog-api-client";

/**
* Resource type, always set to `dataset`.
*/
export type DatasetType = typeof DATASET | UnparsedObject;
export const DATASET = "dataset";
4 changes: 3 additions & 1 deletion services/datasets/src/v2/models/TypingInfo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ import { DatasetUpdateRequest } from "./DatasetUpdateRequest";
import { FiltersPerProduct } from "./FiltersPerProduct";

export const TypingInfo: ModelTypingInfo = {
enumsMap: {},
enumsMap: {
DatasetType: ["dataset"],
},
oneOfMap: {},
typeMap: {
APIErrorResponse: APIErrorResponse,
Expand Down