Merge branch 'v2' into release/batch-1

Author: skarimo

DEVELOPMENT.md

@@ -2,7 +2,7 @@
 
 ## Setup
 
-Developing on this project requires Node 10+, and the Yarn.
+Developing on this project requires Node 18+, and the Yarn.
 
 ## Testing
 
@@ -33,11 +33,11 @@ All test scenarios as automatically generated and located in `features/v*/` fold
 
 ### Step definitions
 
-Implement new steps in `features/step_definitions/request_steps.ts`.
+Implement new steps in `private/bdd_runner/src/step_definitions/request_steps.ts`.
 
 ### Support files
 
-Various support files are located in `features/support` directory:
+Various support files are located in `private/bdd_runner/src/support` directory:
 
 - `given.ts`: implementation for `x-given` extension;
 - `hooks.ts`: logic for skipping tests based on tags and other `Before` and `After` hooks;

README.md

@@ -1,32 +1,23 @@
-# Node.js Datadog API Client
+# Node.js Datadog API Client V2
 
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-This repository contains a Node.js API client for the [Datadog API](https://docs.datadoghq.com/api/).
+This repository contains the V2 rewrite of the TypeScript API client for the [Datadog API](https://docs.datadoghq.com/api/). The client is organized into logical API groups for better maintainability and usability.
 
 ## How to install
 
-The package is under [@datadog/datadog-api-client](https://www.npmjs.com/package/@datadog/datadog-api-client) and can be installed through NPM or Yarn:
-
-```sh
-# NPM
-npm install @datadog/datadog-api-client
-
-# Yarn
-yarn add @datadog/datadog-api-client
-```
+For detailed installation instructions, please refer to the README.md file in each client's directory under `services/{client}/`.
 
 ## Getting Started
 
 Here's an example getting a monitor:
 
 ```typescript
-import { client, v1 } from '@datadog/datadog-api-client';
+import { v1 } from '@datadog/datadog-api-client-monitors';
 
-const configuration = client.createConfiguration();
-const apiInstance = new v1.MonitorsApi(configuration);
+const apiInstance = new v1.MonitorsApiV1();
 
-let params:v1.MonitorsApiGetMonitorRequest = {
+let params: v1.MonitorsApiGetMonitorRequest = {
   // number | The ID of the monitor
   monitorId: 1,
 };
@@ -43,7 +34,8 @@ By default the library will use the `DD_API_KEY` and `DD_APP_KEY` environment va
 To provide your own set of credentials, you need to set the appropriate keys on the configuration:
 
 ```typescript
-import { client } from '@datadog/datadog-api-client';
+import { createConfiguration } from '@datadog/datadog-api-client';
+import { v1 } from '@datadog/datadog-api-client-monitors';
 
 const configurationOpts = {
   authMethods: {
@@ -52,7 +44,8 @@ const configurationOpts = {
   },
 };
 
-const configuration = client.createConfiguration(configurationOpts);
+const configuration = createConfiguration(configurationOpts);
+const apiInstance = new v1.MonitorsApiV1(configuration);
 ```
 
 ### Unstable Endpoints
@@ -70,9 +63,9 @@ where `<operationName>` is the name of the method used to interact with that end
 When talking to a different server, like the `eu` instance, change the server variables:
 
 ```typescript
-import { client } from '@datadog/datadog-api-client';
+import { createConfiguration } from '@datadog/datadog-api-client';
 
-const configuration = client.createConfiguration();
+const configuration = createConfiguration();
 
 configuration.setServerVariables({
   site: "datadoghq.eu"
@@ -85,40 +78,40 @@ If you want to disable GZIP compressed responses, set the `compress` flag
 on your configuration options:
 
 ```typescript
-import { client } from '@datadog/datadog-api-client';
+import { createConfiguration } from '@datadog/datadog-api-client';
 const configurationOpts = {
   httpConfig: {
     compress: false
   },
 };
 
-const configuration = client.createConfiguration(configurationOpts);
+const configuration = createConfiguration(configurationOpts);
 ```
 
 ### Enable requests logging
 
 If you want to enable requests logging, set the `debug` flag on your configuration object:
 
 ```typescript
-import { client } from '@datadog/datadog-api-client';
+import { createConfiguration } from '@datadog/datadog-api-client';
 const configurationOpts = {
   debug: true
 };
 
-const configuration = client.createConfiguration(configurationOpts);
+const configuration = createConfiguration(configurationOpts);
 ```
 
 ### Enable retry 
 
 To enable the client to retry when rate limited (status 429) or status 500 and above:
 
 ```typescript
-import { client } from '@datadog/datadog-api-client';
+import { createConfiguration } from '@datadog/datadog-api-client';
 const configurationOpts = {
   enableRetry: true
 };
 
-const configuration = client.createConfiguration(configurationOpts);
+const configuration = createConfiguration(configurationOpts);
 ```
 The interval between 2 retry attempts will be the value of the x-ratelimit-reset response header when available. If not, it will be :
 
@@ -139,7 +132,9 @@ controller, for example the one implemented by
 then pass the `signal method to the HTTP configuration options:
 
 ```typescript
-import { client, v1 } from '@datadog/datadog-api-client';
+import { createConfiguration } from '@datadog/datadog-api-client';
+import { v1 } from '@datadog/datadog-api-client-monitors'
+
 import AbortController from 'abort-controller';
 
 const controller = new AbortController();
@@ -153,7 +148,7 @@ const configurationOpts = {
   },
 };
 
-const configuration = client.createConfiguration(configurationOpts);
+const configuration = createConfiguration(configurationOpts);
 
 const apiInstance = new v1.MonitorsApi(configuration);
 apiInstance.listMonitors().then((data: v1.Monitor[]) => {
@@ -167,10 +162,11 @@ Several listing operations have a pagination method to help consume all the item
 For example, to retrieve all your incidents:
 
 ```typescript
-import { client, v2 } from "@datadog/datadog-api-client";
+import { createConfiguration } from "@datadog/datadog-api-client";
+import { v2 } from "@datadog/datadog-api-client-incidents";
 
 async function main() {
-  const configuration = client.createConfiguration();
+  const configuration = createConfiguration();
   configuration.unstableOperations["v2.listIncidents"] = true;
   const apiInstance = new v2.IncidentsApi(configuration);
 
@@ -191,13 +187,14 @@ For example, using `zstd.ts` package:
 
 ```typescript
 import { compressSync } from 'zstd.ts'
-import { client, v2 } from "@datadog/datadog-api-client";
+import { createConfiguration } from "@datadog/datadog-api-client";
+import { v2 } from "@datadog/datadog-api-client-metrics";
 
 async function main() {
   const configurationOpts = {
     zstdCompressorCallback: (body: string) => compressSync({input: Buffer.from(body, "utf8")})
   }
-  const configuration = client.createConfiguration(configurationOpts);
+  const configuration = createConfiguration(configurationOpts);
   const apiInstance = new v2.MetricsApi(configuration);
   const params: v2.MetricsApiSubmitMetricsRequest = {
       body: {
@@ -236,14 +233,16 @@ import pako from "pako";
 import bufferFrom from "buffer-from";
 import fetch from "node-fetch";
 import { HttpsProxyAgent } from "https-proxy-agent";
-import { v1, client } from "@datadog/datadog-api-client";
+
+import { createConfiguration, ResponseContext, RequestContext, HttpLibrary } from "@datadog/datadog-api-client";
+import { v1 } from "@datadog/datadog-api-client";
 
 const proxyAgent = new HttpsProxyAgent('http://127.0.0.11:3128');
 
-class HttpLibraryWithProxy implements client.HttpLibrary {
+class HttpLibraryWithProxy implements HttpLibrary {
     public debug = false;
 
-    public send(request: client.RequestContext): Promise<client.ResponseContext> {
+    public send(request: RequestContext): Promise<ResponseContext> {
         const method = request.getHttpMethod().toString();
         let body = request.getBody();
 
@@ -278,15 +277,15 @@ class HttpLibraryWithProxy implements client.HttpLibrary {
                 text: () => resp.text(),
                 binary: () => resp.buffer(),
             };
-            const response = new client.ResponseContext(resp.status, headers, body);
+            const response = new ResponseContext(resp.status, headers, body);
             return response;
         });
 
         return resultPromise;
     }
 }
 
-const configuration = client.createConfiguration({httpApi: new HttpLibraryWithProxy()});
+const configuration = createConfiguration({httpApi: new HttpLibraryWithProxy()});
 const apiInstance = new v1.DashboardsApi(configuration);
 
 apiInstance

cassettes/v2/Workflow-Automation_3507381207/Create-a-Workflow-returns-Bad-request-response_2263290237/frozen.json

@@ -1 +1 @@
-"2025-02-04T04:58:32.931Z"
+"2025-05-26T17:23:42.973Z"

cassettes/v2/Workflow-Automation_3507381207/Create-a-Workflow-returns-Bad-request-response_2263290237/recording.har

@@ -26,7 +26,7 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 539,
+          "headersSize": 558,
           "httpVersion": "HTTP/1.1",
           "method": "POST",
           "postData": {
@@ -38,11 +38,11 @@
           "url": "https://api.datadoghq.com/api/v2/workflows"
         },
         "response": {
-          "bodySize": 85,
+          "bodySize": 179,
           "content": {
             "mimeType": "application/vnd.api+json",
-            "size": 85,
-            "text": "{\"errors\":[{\"detail\":\"workflow description exceeds size limit of [300] characters\"}]}"
+            "size": 179,
+            "text": "{\"errors\":[{\"detail\":\"workflow description exceeds size limit of [300] characters\"},{\"detail\":\"spec is invalid\"},{\"detail\":\"no trigger found. At least one trigger is required.\"}]}"
           },
           "cookies": [],
           "headers": [
@@ -51,14 +51,14 @@
               "value": "application/vnd.api+json"
             }
           ],
-          "headersSize": 660,
+          "headersSize": 656,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 400,
           "statusText": "Bad Request"
         },
-        "startedDateTime": "2025-02-04T04:58:32.940Z",
-        "time": 167
+        "startedDateTime": "2025-05-26T17:23:42.977Z",
+        "time": 102
       }
     ],
     "pages": [],

cassettes/v2/Workflow-Automation_3507381207/Create-a-Workflow-returns-Successfully-created-a-workflow-response_1639570320/frozen.json

@@ -1 +1 @@
-"2025-02-04T04:58:33.114Z"
+"2025-05-26T17:23:43.084Z"

cassettes/v2/Workflow-Automation_3507381207/Create-a-Workflow-returns-Successfully-created-a-workflow-response_1639570320/recording.har

@@ -8,11 +8,11 @@
     },
     "entries": [
       {
-        "_id": "4ea99b6c255c11413fea0a5165d54bd7",
+        "_id": "fec91cc962029b2d77bb53fe2e45b9c4",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 981,
+          "bodySize": 960,
           "cookies": [],
           "headers": [
             {
@@ -26,23 +26,23 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 539,
+          "headersSize": 558,
           "httpVersion": "HTTP/1.1",
           "method": "POST",
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"data\":{\"attributes\":{\"description\":\"A sample workflow.\",\"name\":\"Example Workflow\",\"published\":true,\"spec\":{\"connectionEnvs\":[{\"connections\":[{\"connectionId\":\"11111111-1111-1111-1111-111111111111\",\"label\":\"INTEGRATION_DATADOG\"}],\"env\":\"default\"}],\"handle\":\"my-handle\",\"inputSchema\":{\"parameters\":[{\"defaultValue\":\"default\",\"name\":\"input\",\"type\":\"STRING\"}]},\"outputSchema\":{\"parameters\":[{\"name\":\"output\",\"type\":\"ARRAY_OBJECT\",\"value\":\"outputValue\"}]},\"steps\":[{\"actionId\":\"com.datadoghq.dd.monitor.listMonitors\",\"connectionLabel\":\"INTEGRATION_DATADOG\",\"name\":\"Step1\",\"outboundEdges\":[{\"branchName\":\"main\",\"nextStepName\":\"Step2\"}],\"parameters\":[{\"name\":\"tags\",\"value\":\"service:monitoring\"}]},{\"actionId\":\"com.datadoghq.core.noop\",\"name\":\"Step2\"}],\"triggers\":[{\"monitorTrigger\":{\"rateLimit\":{\"count\":1,\"interval\":\"3600s\"}},\"startStepNames\":[\"Step1\"]},{\"githubWebhookTrigger\":{},\"startStepNames\":[\"Step1\"]}]},\"tags\":[\"team:infra\",\"service:monitoring\",\"foo:bar\"]},\"type\":\"workflows\"}}"
+            "text": "{\"data\":{\"attributes\":{\"description\":\"A sample workflow.\",\"name\":\"Example Workflow\",\"published\":true,\"spec\":{\"connectionEnvs\":[{\"connections\":[{\"connectionId\":\"11111111-1111-1111-1111-111111111111\",\"label\":\"INTEGRATION_DATADOG\"}],\"env\":\"default\"}],\"inputSchema\":{\"parameters\":[{\"defaultValue\":\"default\",\"name\":\"input\",\"type\":\"STRING\"}]},\"outputSchema\":{\"parameters\":[{\"name\":\"output\",\"type\":\"ARRAY_OBJECT\",\"value\":\"outputValue\"}]},\"steps\":[{\"actionId\":\"com.datadoghq.dd.monitor.listMonitors\",\"connectionLabel\":\"INTEGRATION_DATADOG\",\"name\":\"Step1\",\"outboundEdges\":[{\"branchName\":\"main\",\"nextStepName\":\"Step2\"}],\"parameters\":[{\"name\":\"tags\",\"value\":\"service:monitoring\"}]},{\"actionId\":\"com.datadoghq.core.noop\",\"name\":\"Step2\"}],\"triggers\":[{\"monitorTrigger\":{\"rateLimit\":{\"count\":1,\"interval\":\"3600s\"}},\"startStepNames\":[\"Step1\"]},{\"githubWebhookTrigger\":{},\"startStepNames\":[\"Step1\"]}]},\"tags\":[\"team:infra\",\"service:monitoring\",\"foo:bar\"]},\"type\":\"workflows\"}}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v2/workflows"
         },
         "response": {
-          "bodySize": 1285,
+          "bodySize": 1280,
           "content": {
             "mimeType": "application/vnd.api+json",
-            "size": 1285,
-            "text": "{\"data\":{\"id\":\"cb8dd95a-1463-495d-99d6-95efcd86e74e\",\"type\":\"workflows\",\"attributes\":{\"createdAt\":\"2025-02-04T04:58:33.224986Z\",\"description\":\"A sample workflow.\",\"name\":\"Example Workflow\",\"published\":true,\"spec\":{\"triggers\":[{\"startStepNames\":[\"Step1\"],\"monitorTrigger\":{\"rateLimit\":{\"count\":1,\"interval\":\"3600s\"}}},{\"startStepNames\":[\"Step1\"],\"githubWebhookTrigger\":{}}],\"steps\":[{\"name\":\"Step1\",\"actionId\":\"com.datadoghq.dd.monitor.listMonitors\",\"connectionLabel\":\"INTEGRATION_DATADOG\",\"parameters\":[{\"name\":\"tags\",\"value\":\"service:monitoring\"}],\"outboundEdges\":[{\"nextStepName\":\"Step2\",\"branchName\":\"main\"}]},{\"name\":\"Step2\",\"actionId\":\"com.datadoghq.core.noop\"}],\"handle\":\"my-handle\",\"connectionEnvs\":[{\"env\":\"default\",\"connections\":[{\"connectionId\":\"11111111-1111-1111-1111-111111111111\",\"label\":\"INTEGRATION_DATADOG\"}]}],\"inputSchema\":{\"parameters\":[{\"name\":\"input\",\"type\":\"STRING\",\"defaultValue\":\"default\"}]},\"outputSchema\":{\"parameters\":[{\"name\":\"output\",\"type\":\"ARRAY_OBJECT\",\"value\":\"outputValue\"}]}},\"tags\":[\"foo:bar\",\"team:infra\",\"service:monitoring\"],\"updatedAt\":\"2025-02-04T04:58:33.224986Z\"},\"relationships\":{\"creator\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}},\"owner\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}}}}}"
+            "size": 1280,
+            "text": "{\"data\":{\"id\":\"c850935f-15fc-4e5b-8903-d68066c5343a\",\"type\":\"workflows\",\"attributes\":{\"createdAt\":\"2025-05-26T17:23:43.255617Z\",\"description\":\"A sample workflow.\",\"name\":\"Example Workflow\",\"published\":true,\"spec\":{\"triggers\":[{\"startStepNames\":[\"Step1\"],\"monitorTrigger\":{\"rateLimit\":{\"count\":1,\"interval\":\"3600s\"}}},{\"startStepNames\":[\"Step1\"],\"githubWebhookTrigger\":{}}],\"steps\":[{\"name\":\"Step1\",\"actionId\":\"com.datadoghq.dd.monitor.listMonitors\",\"connectionLabel\":\"INTEGRATION_DATADOG\",\"parameters\":[{\"name\":\"tags\",\"value\":\"service:monitoring\"}],\"outboundEdges\":[{\"nextStepName\":\"Step2\",\"branchName\":\"main\"}]},{\"name\":\"Step2\",\"actionId\":\"com.datadoghq.core.noop\"}],\"connectionEnvs\":[{\"env\":\"default\",\"connections\":[{\"connectionId\":\"11111111-1111-1111-1111-111111111111\",\"label\":\"INTEGRATION_DATADOG\"}]}],\"inputSchema\":{\"parameters\":[{\"name\":\"input\",\"type\":\"STRING\",\"defaultValue\":\"default\"}]},\"outputSchema\":{\"parameters\":[{\"name\":\"output\",\"type\":\"ARRAY_OBJECT\",\"value\":\"outputValue\"}]}},\"tags\":[\"foo:bar\",\"service:monitoring\",\"team:infra\"],\"updatedAt\":\"2025-05-26T17:23:43.255617Z\"},\"relationships\":{\"creator\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}},\"owner\":{\"data\":{\"id\":\"3ad549bf-eba0-11e9-a77a-0705486660d0\",\"type\":\"users\"}}}}}"
           },
           "cookies": [],
           "headers": [
@@ -51,17 +51,17 @@
               "value": "application/vnd.api+json"
             }
           ],
-          "headersSize": 662,
+          "headersSize": 657,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 201,
           "statusText": "Created"
         },
-        "startedDateTime": "2025-02-04T04:58:33.117Z",
-        "time": 119
+        "startedDateTime": "2025-05-26T17:23:43.086Z",
+        "time": 207
       },
       {
-        "_id": "9384953c7e69c85a3baf0296d8482df5",
+        "_id": "453a84c4ac476fa849ae639041414e15",
         "_order": 0,
         "cache": {},
         "request": {
@@ -74,11 +74,11 @@
               "value": "*/*"
             }
           ],
-          "headersSize": 512,
+          "headersSize": 531,
           "httpVersion": "HTTP/1.1",
           "method": "DELETE",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v2/workflows/cb8dd95a-1463-495d-99d6-95efcd86e74e"
+          "url": "https://api.datadoghq.com/api/v2/workflows/c850935f-15fc-4e5b-8903-d68066c5343a"
         },
         "response": {
           "bodySize": 0,
@@ -88,14 +88,14 @@
           },
           "cookies": [],
           "headers": [],
-          "headersSize": 600,
+          "headersSize": 595,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 204,
           "statusText": "No Content"
         },
-        "startedDateTime": "2025-02-04T04:58:33.243Z",
-        "time": 92
+        "startedDateTime": "2025-05-26T17:23:43.304Z",
+        "time": 128
       }
     ],
     "pages": [],

cassettes/v2/Workflow-Automation_3507381207/Delete-an-existing-Workflow-returns-Not-found-response_970464114/frozen.json

@@ -1 +1 @@
-"2025-02-04T04:58:33.338Z"
+"2025-05-26T17:23:43.439Z"