Fix missing field in Synthetics tests authentication configuration (#940)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 32dbbcf895da · 2022-12-08T13:39:01.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-12-05 18:23:31.425987",
-            "spec_repo_commit": "1cc231e1"
+            "regenerated": "2022-12-08 13:18:30.553175",
+            "spec_repo_commit": "65b2053a"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-12-05 18:23:31.437612",
-            "spec_repo_commit": "1cc231e1"
+            "regenerated": "2022-12-08 13:18:30.569528",
+            "spec_repo_commit": "65b2053a"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -11716,6 +11716,8 @@ components:
           description: Scope to use when performing the authentication.
           example: scope
           type: string
+        tokenApiAuthentication:
+          $ref: '#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication'
         type:
           $ref: '#/components/schemas/SyntheticsBasicAuthOauthROPType'
         username:
@@ -11725,6 +11727,7 @@ components:
       required:
       - accessTokenUrl
       - password
+      - tokenApiAuthentication
       - username
       type: object
     SyntheticsBasicAuthOauthROPType:
diff --git a/cassettes/v1/Synthetics_2658572017/Create-an-API-HTTP-with-oauth-rop-test-returns-OK-Returns-the-created-test-details-respon_2355308624/frozen.json b/cassettes/v1/Synthetics_2658572017/Create-an-API-HTTP-with-oauth-rop-test-returns-OK-Returns-the-created-test-details-respon_2355308624/frozen.json
@@ -0,0 +1 @@
+"2022-12-07T10:36:18.554Z"
diff --git a/cassettes/v1/Synthetics_2658572017/Create-an-API-HTTP-with-oauth-rop-test-returns-OK-Returns-the-created-test-details-respon_2355308624/recording.har b/cassettes/v1/Synthetics_2658572017/Create-an-API-HTTP-with-oauth-rop-test-returns-OK-Returns-the-created-test-details-respon_2355308624/recording.har
@@ -0,0 +1,120 @@
+{
+  "log": {
+    "_recordingName": "Synthetics/Create an API HTTP with oauth-rop test returns \"OK - Returns the created test details.\" response",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "7a314475838068c3894780495c104da2",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 1835,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 579,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"config\":{\"assertions\":[{\"operator\":\"is\",\"property\":\"{{ PROPERTY }}\",\"target\":\"text/html\",\"type\":\"header\"},{\"operator\":\"lessThan\",\"target\":2000,\"type\":\"responseTime\"},{\"operator\":\"validatesJSONPath\",\"target\":{\"jsonPath\":\"topKey\",\"operator\":\"isNot\",\"targetValue\":\"0\"},\"type\":\"body\"},{\"operator\":\"validatesXPath\",\"target\":{\"operator\":\"contains\",\"targetValue\":\"0\",\"xPath\":\"target-xpath\"},\"type\":\"body\"}],\"configVariables\":[{\"example\":\"content-type\",\"name\":\"PROPERTY\",\"pattern\":\"content-type\",\"type\":\"text\"}],\"request\":{\"basicAuth\":{\"accessTokenUrl\":\"https://datadog-token.com\",\"audience\":\"audience\",\"clientId\":\"client-id\",\"clientSecret\":\"client-secret\",\"password\":\"oauth-password\",\"resource\":\"resource\",\"scope\":\"yoyo\",\"tokenApiAuthentication\":\"body\",\"type\":\"oauth-rop\",\"username\":\"oauth-usermame\"},\"certificate\":{\"cert\":{\"content\":\"cert-content\",\"filename\":\"cert-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"},\"key\":{\"content\":\"key-content\",\"filename\":\"key-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"}},\"headers\":{\"unique\":\"testcreateanapihttpwithoauthroptestreturnsokreturnsthecreatedtestdetailsresponse1670409378\"},\"method\":\"GET\",\"proxy\":{\"headers\":{},\"url\":\"https://datadoghq.com\"},\"timeout\":10,\"url\":\"https://datadoghq.com\"}},\"locations\":[\"aws:us-east-2\"],\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"name\":\"Test-Create_an_API_HTTP_with_oauth_rop_test_returns_OK_Returns_the_created_test_details_response-1670409378\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Create_an_API_HTTP_with_oauth_rop_test_returns_OK_Returns_the_created_test_details_response-1670409378\",\"monitor_priority\":5,\"retry\":{\"count\":3,\"interval\":10},\"tick_every\":60},\"subtype\":\"http\",\"tags\":[\"testing:api\"],\"type\":\"api\"}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/synthetics/tests/api"
+        },
+        "response": {
+          "bodySize": 1983,
+          "content": {
+            "mimeType": "application/json",
+            "size": 1983,
+            "text": "{\"status\":\"live\",\"public_id\":\"u7x-e98-98f\",\"tags\":[\"testing:api\"],\"org_id\":569509,\"locations\":[\"aws:us-east-2\"],\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"deleted_at\":null,\"name\":\"Test-Create_an_API_HTTP_with_oauth_rop_test_returns_OK_Returns_the_created_test_details_response-1670409378\",\"monitor_id\":105046994,\"type\":\"api\",\"created_at\":\"2022-12-07T10:36:19.000736+00:00\",\"modified_at\":\"2022-12-07T10:36:19.000736+00:00\",\"subtype\":\"http\",\"config\":{\"request\":{\"certificate\":{\"cert\":{\"filename\":\"cert-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"},\"key\":{\"filename\":\"key-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"}},\"url\":\"https://datadoghq.com\",\"basicAuth\":{\"username\":\"oauth-usermame\",\"clientSecret\":\"client-secret\",\"resource\":\"resource\",\"accessTokenUrl\":\"https://datadog-token.com\",\"audience\":\"audience\",\"clientId\":\"client-id\",\"scope\":\"yoyo\",\"password\":\"oauth-password\",\"type\":\"oauth-rop\",\"tokenApiAuthentication\":\"body\"},\"headers\":{\"unique\":\"testcreateanapihttpwithoauthroptestreturnsokreturnsthecreatedtestdetailsresponse1670409378\"},\"proxy\":{\"url\":\"https://datadoghq.com\",\"headers\":{}},\"timeout\":10,\"method\":\"GET\"},\"assertions\":[{\"operator\":\"is\",\"property\":\"{{ PROPERTY }}\",\"type\":\"header\",\"target\":\"text/html\"},{\"operator\":\"lessThan\",\"type\":\"responseTime\",\"target\":2000},{\"operator\":\"validatesJSONPath\",\"type\":\"body\",\"target\":{\"operator\":\"isNot\",\"targetValue\":\"0\",\"jsonPath\":\"topKey\"}},{\"operator\":\"validatesXPath\",\"type\":\"body\",\"target\":{\"operator\":\"contains\",\"targetValue\":\"0\",\"xPath\":\"target-xpath\"}}],\"configVariables\":[{\"pattern\":\"content-type\",\"type\":\"text\",\"example\":\"content-type\",\"name\":\"PROPERTY\"}]},\"options\":{\"accept_self_signed\":false,\"retry\":{\"count\":3,\"interval\":10},\"min_location_failed\":1,\"allow_insecure\":true,\"follow_redirects\":true,\"min_failure_duration\":10,\"monitor_priority\":5,\"monitor_name\":\"Test-Create_an_API_HTTP_with_oauth_rop_test_returns_OK_Returns_the_created_test_details_response-1670409378\",\"tick_every\":60}}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 624,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-12-07T10:36:18.560Z",
+        "time": 517
+      },
+      {
+        "_id": "a88e911d306f47fb3fe5a6b32a5049c5",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 30,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 568,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"public_ids\":[\"u7x-e98-98f\"]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/synthetics/tests/delete"
+        },
+        "response": {
+          "bodySize": 96,
+          "content": {
+            "mimeType": "application/json",
+            "size": 96,
+            "text": "{\"deleted_tests\":[{\"deleted_at\":\"2022-12-07T10:36:19.441845+00:00\",\"public_id\":\"u7x-e98-98f\"}]}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 622,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-12-07T10:36:19.085Z",
+        "time": 469
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}
diff --git a/examples/v1/synthetics/CreateSyntheticsAPITest_960766374.ts b/examples/v1/synthetics/CreateSyntheticsAPITest_960766374.ts
@@ -0,0 +1,121 @@
+/**
+ * Create an API HTTP with oauth-rop test returns "OK - Returns the created test details." response
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.SyntheticsApi(configuration);
+
+const params: v1.SyntheticsApiCreateSyntheticsAPITestRequest = {
+  body: {
+    config: {
+      assertions: [
+        {
+          operator: "is",
+          property: "{{ PROPERTY }}",
+          target: "text/html",
+          type: "header",
+        },
+        {
+          operator: "lessThan",
+          target: 2000,
+          type: "responseTime",
+        },
+        {
+          operator: "validatesJSONPath",
+          target: {
+            jsonPath: "topKey",
+            operator: "isNot",
+            targetValue: "0",
+          },
+          type: "body",
+        },
+        {
+          operator: "validatesXPath",
+          target: {
+            xPath: "target-xpath",
+            targetValue: "0",
+            operator: "contains",
+          },
+          type: "body",
+        },
+      ],
+      configVariables: [
+        {
+          example: "content-type",
+          name: "PROPERTY",
+          pattern: "content-type",
+          type: "text",
+        },
+      ],
+      request: {
+        certificate: {
+          cert: {
+            content: "cert-content",
+            filename: "cert-filename",
+            updatedAt: "2020-10-16T09:23:24.857Z",
+          },
+          key: {
+            content: "key-content",
+            filename: "key-filename",
+            updatedAt: "2020-10-16T09:23:24.857Z",
+          },
+        },
+        headers: {
+          unique:
+            "examplecreateanapihttpwithoauthroptestreturnsokreturnsthecreatedtestdetailsresponse",
+        },
+        method: "GET",
+        timeout: 10,
+        url: "https://datadoghq.com",
+        proxy: {
+          url: "https://datadoghq.com",
+          headers: {},
+        },
+        basicAuth: {
+          accessTokenUrl: "https://datadog-token.com",
+          audience: "audience",
+          clientId: "client-id",
+          clientSecret: "client-secret",
+          resource: "resource",
+          scope: "yoyo",
+          tokenApiAuthentication: "body",
+          type: "oauth-rop",
+          username: "oauth-usermame",
+          password: "oauth-password",
+        },
+      },
+    },
+    locations: ["aws:us-east-2"],
+    message: "BDD test payload: synthetics_api_http_test_payload.json",
+    name: "Example-Create_an_API_HTTP_with_oauth_rop_test_returns_OK_Returns_the_created_test_details_response",
+    options: {
+      acceptSelfSigned: false,
+      allowInsecure: true,
+      followRedirects: true,
+      minFailureDuration: 10,
+      minLocationFailed: 1,
+      monitorName:
+        "Example-Create_an_API_HTTP_with_oauth_rop_test_returns_OK_Returns_the_created_test_details_response",
+      monitorPriority: 5,
+      retry: {
+        count: 3,
+        interval: 10,
+      },
+      tickEvery: 60,
+    },
+    subtype: "http",
+    tags: ["testing:api"],
+    type: "api",
+  },
+};
+
+apiInstance
+  .createSyntheticsAPITest(params)
+  .then((data: v1.SyntheticsAPITest) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));
diff --git a/features/v1/synthetics.feature b/features/v1/synthetics.feature
@@ -124,6 +124,14 @@ Feature: Synthetics
     Then the response status is 200 OK - Returns the created test details.
     And the response "name" is equal to "{{ unique }}"
 
+  @team:DataDog/synthetics-app
+  Scenario: Create an API HTTP with oauth-rop test returns "OK - Returns the created test details." response
+    Given new "CreateSyntheticsAPITest" request
+    And body from file "synthetics_api_http_test_oauth_rop_payload.json"
+    When the request is sent
+    Then the response status is 200 OK - Returns the created test details.
+    And the response "name" is equal to "{{ unique }}"
+
   @team:DataDog/synthetics-app
   Scenario: Create an API SSL test returns "OK - Returns the created test details." response
     Given new "CreateSyntheticsAPITest" request
diff --git a/features/v1/synthetics_api_http_test_oauth_rop_payload.json b/features/v1/synthetics_api_http_test_oauth_rop_payload.json
@@ -0,0 +1,90 @@
+{
+  "config": {
+    "assertions": [
+      {
+        "operator": "is",
+        "property": "{{ '{{ PROPERTY }}' }}",
+        "target": "text/html",
+        "type": "header"
+      },
+      { "operator": "lessThan", "target": 2000, "type": "responseTime" },
+      {
+        "operator": "validatesJSONPath",
+        "target": {
+          "jsonPath": "topKey",
+          "operator": "isNot",
+          "targetValue": "0"
+        },
+        "type": "body"
+      },
+      {
+        "operator": "validatesXPath",
+        "target": {
+          "xPath": "target-xpath",
+          "targetValue": "0",
+          "operator": "contains"
+        },
+        "type": "body"
+      }
+    ],
+    "configVariables": [
+      {
+        "example": "content-type",
+        "name": "PROPERTY",
+        "pattern": "content-type",
+        "type": "text"
+      }
+    ],
+    "request": {
+      "certificate": {
+        "cert": {
+          "content": "cert-content",
+          "filename": "cert-filename",
+          "updatedAt": "2020-10-16T09:23:24.857Z"
+        },
+        "key": {
+          "content": "key-content",
+          "filename": "key-filename",
+          "updatedAt": "2020-10-16T09:23:24.857Z"
+        }
+      },
+      "headers": { "unique": "{{ unique_lower_alnum }}" },
+      "method": "GET",
+      "timeout": 10,
+      "url": "https://datadoghq.com",
+      "proxy": {
+        "url": "https://datadoghq.com",
+        "headers": {}
+      },
+      "basicAuth": {
+        "accessTokenUrl": "https://datadog-token.com",
+        "audience": "audience",
+        "clientId": "client-id",
+        "clientSecret": "client-secret",
+        "resource": "resource",
+        "scope": "yoyo",
+        "tokenApiAuthentication": "body",
+        "type": "oauth-rop",
+        "username": "oauth-usermame",
+        "password": "oauth-password"
+      }
+    }
+  },
+  "locations": ["aws:us-east-2"],
+  "message": "BDD test payload: synthetics_api_http_test_payload.json",
+  "name": "{{ unique }}",
+  "options": {
+    "accept_self_signed": false,
+    "allow_insecure": true,
+    "follow_redirects": true,
+    "min_failure_duration": 10,
+    "min_location_failed": 1,
+    "monitor_name": "{{ unique }}",
+    "monitor_priority": 5,
+    "retry": { "count": 3, "interval": 10 },
+    "tick_every": 60
+  },
+  "subtype": "http",
+  "tags": ["testing:api"],
+  "type": "api"
+}
diff --git a/packages/datadog-api-client-v1/models/SyntheticsBasicAuthOauthROP.ts b/packages/datadog-api-client-v1/models/SyntheticsBasicAuthOauthROP.ts

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.4",`
`7`		`- "regenerated": "2022-12-05 18:23:31.425987",`
`8`		`- "spec_repo_commit": "1cc231e1"`
	`7`	`+ "regenerated": "2022-12-08 13:18:30.553175",`
	`8`	`+ "spec_repo_commit": "65b2053a"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2022-12-05 18:23:31.437612",`
`13`		`- "spec_repo_commit": "1cc231e1"`
	`12`	`+ "regenerated": "2022-12-08 13:18:30.569528",`
	`13`	`+ "spec_repo_commit": "65b2053a"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`