Add OAuth support for Synthetics tests (#923)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-11-22 09:27:51.040191",
-            "spec_repo_commit": "b67ecba8"
+            "regenerated": "2022-11-22 13:49:05.695818",
+            "spec_repo_commit": "dad9f2c8"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-11-22 09:27:51.057725",
-            "spec_repo_commit": "b67ecba8"
+            "regenerated": "2022-11-22 13:49:05.708257",
+            "spec_repo_commit": "dad9f2c8"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -11523,6 +11523,8 @@ components:
       - $ref: '#/components/schemas/SyntheticsBasicAuthSigv4'
       - $ref: '#/components/schemas/SyntheticsBasicAuthNTLM'
       - $ref: '#/components/schemas/SyntheticsBasicAuthDigest'
+      - $ref: '#/components/schemas/SyntheticsBasicAuthOauthClient'
+      - $ref: '#/components/schemas/SyntheticsBasicAuthOauthROP'
       type: object
     SyntheticsBasicAuthDigest:
       description: Object to handle digest authentication when performing the test.
@@ -11586,6 +11588,115 @@ components:
       type: string
       x-enum-varnames:
       - NTLM
+    SyntheticsBasicAuthOauthClient:
+      description: Object to handle `oauth client` authentication when performing
+        the test.
+      properties:
+        accessTokenUrl:
+          description: Access token URL to use when performing the authentication.
+          example: https://example.com
+          type: string
+        audience:
+          description: Audience to use when performing the authentication.
+          example: audience
+          type: string
+        clientId:
+          description: Client ID to use when performing the authentication.
+          example: oauth-username
+          type: string
+        clientSecret:
+          description: Client secret to use when performing the authentication.
+          example: oauth-password
+          type: string
+        resource:
+          description: Resource to use when performing the authentication.
+          example: resource
+          type: string
+        scope:
+          description: Scope to use when performing the authentication.
+          example: scope
+          type: string
+        tokenApiAuthentication:
+          $ref: '#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication'
+        type:
+          $ref: '#/components/schemas/SyntheticsBasicAuthOauthClientType'
+      required:
+      - accessTokenUrl
+      - tokenApiAuthentication
+      - clientId
+      - clientSecret
+      type: object
+    SyntheticsBasicAuthOauthClientType:
+      default: oauth-client
+      description: The type of basic authentication to use when performing the test.
+      enum:
+      - oauth-client
+      example: oauth-client
+      type: string
+      x-enum-varnames:
+      - OAUTH_CLIENT
+    SyntheticsBasicAuthOauthROP:
+      description: Object to handle `oauth rop` authentication when performing the
+        test.
+      properties:
+        accessTokenUrl:
+          description: Access token URL to use when performing the authentication.
+          example: https://example.com
+          type: string
+        audience:
+          description: Audience to use when performing the authentication.
+          example: audience
+          type: string
+        clientId:
+          description: Client ID to use when performing the authentication.
+          example: client-id
+          type: string
+        clientSecret:
+          description: Client secret to use when performing the authentication.
+          example: client-secret
+          type: string
+        password:
+          description: Password to use when performing the authentication.
+          example: password
+          type: string
+        resource:
+          description: Resource to use when performing the authentication.
+          example: resource
+          type: string
+        scope:
+          description: Scope to use when performing the authentication.
+          example: scope
+          type: string
+        type:
+          $ref: '#/components/schemas/SyntheticsBasicAuthOauthROPType'
+        username:
+          description: Username to use when performing the authentication.
+          example: username
+          type: string
+      required:
+      - accessTokenUrl
+      - password
+      - username
+      type: object
+    SyntheticsBasicAuthOauthROPType:
+      default: oauth-rop
+      description: The type of basic authentication to use when performing the test.
+      enum:
+      - oauth-rop
+      example: oauth-rop
+      type: string
+      x-enum-varnames:
+      - OAUTH_ROP
+    SyntheticsBasicAuthOauthTokenApiAuthentication:
+      description: Type of token to use when performing the authentication.
+      enum:
+      - header
+      - body
+      example: header
+      type: string
+      x-enum-varnames:
+      - HEADER
+      - BODY
     SyntheticsBasicAuthSigv4:
       description: Object to handle `SIGV4` authentication when performing the test.
       properties:

cassettes/v1/Monitors_4022238206/Get-a-synthetics-monitor-s-details_2292154114/frozen.json

@@ -1 +1 @@
-"2022-11-08T09:31:12.771Z"
+"2022-11-21T13:20:41.192Z"

cassettes/v1/Monitors_4022238206/Get-a-synthetics-monitor-s-details_2292154114/recording.har

@@ -8,11 +8,11 @@
     },
     "entries": [
       {
-        "_id": "2abd75f59b0d9f67de34929ac9a992b2",
+        "_id": "3a11d1dbd49031df6f3bc5d71212d8cd",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 1395,
+          "bodySize": 1623,
           "cookies": [],
           "headers": [
             {
@@ -32,17 +32,17 @@
           "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\":{\"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\":\"testgetasyntheticsmonitorsdetails1667899872\"},\"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-Get_a_synthetics_monitor_s_details-1667899872\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Get_a_synthetics_monitor_s_details-1667899872\",\"monitor_priority\":5,\"retry\":{\"count\":3,\"interval\":10},\"tick_every\":60},\"subtype\":\"http\",\"tags\":[\"testing:api\"],\"type\":\"api\"}"
+            "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\",\"resource\":\"resource\",\"scope\":\"yoyo\",\"tokenApiAuthentication\":\"header\",\"type\":\"oauth-client\"},\"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\":\"testgetasyntheticsmonitorsdetails1669036841\"},\"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-Get_a_synthetics_monitor_s_details-1669036841\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Get_a_synthetics_monitor_s_details-1669036841\",\"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": 1543,
+          "bodySize": 1771,
           "content": {
             "mimeType": "application/json",
-            "size": 1543,
-            "text": "{\"status\":\"live\",\"public_id\":\"2ud-5q9-dwc\",\"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-Get_a_synthetics_monitor_s_details-1667899872\",\"monitor_id\":102332053,\"type\":\"api\",\"created_at\":\"2022-11-08T09:31:13.173822+00:00\",\"modified_at\":\"2022-11-08T09:31:13.173822+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\",\"headers\":{\"unique\":\"testgetasyntheticsmonitorsdetails1667899872\"},\"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-Get_a_synthetics_monitor_s_details-1667899872\",\"tick_every\":60}}"
+            "size": 1771,
+            "text": "{\"status\":\"live\",\"public_id\":\"ahw-qah-d9b\",\"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-Get_a_synthetics_monitor_s_details-1669036841\",\"monitor_id\":103654710,\"type\":\"api\",\"created_at\":\"2022-11-21T13:20:41.629289+00:00\",\"modified_at\":\"2022-11-21T13:20:41.629289+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\":{\"clientSecret\":\"client-secret\",\"resource\":\"resource\",\"accessTokenUrl\":\"https://datadog-token.com\",\"audience\":\"audience\",\"clientId\":\"client-id\",\"scope\":\"yoyo\",\"type\":\"oauth-client\",\"tokenApiAuthentication\":\"header\"},\"headers\":{\"unique\":\"testgetasyntheticsmonitorsdetails1669036841\"},\"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-Get_a_synthetics_monitor_s_details-1669036841\",\"tick_every\":60}}"
           },
           "cookies": [],
           "headers": [
@@ -57,11 +57,11 @@
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2022-11-08T09:31:12.775Z",
-        "time": 459
+        "startedDateTime": "2022-11-21T13:20:41.196Z",
+        "time": 493
       },
       {
-        "_id": "038f7b09fa1a745b5afbbb3784faebaf",
+        "_id": "a578adb795248483ad9ef8f100c5c067",
         "_order": 0,
         "cache": {},
         "request": {
@@ -78,14 +78,14 @@
           "httpVersion": "HTTP/1.1",
           "method": "GET",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v1/monitor/102332053"
+          "url": "https://api.datadoghq.com/api/v1/monitor/103654710"
         },
         "response": {
           "bodySize": 815,
           "content": {
             "mimeType": "application/json",
             "size": 815,
-            "text": "{\"restricted_roles\":null,\"tags\":[\"testing:api\",\"probe_dc:aws:us-east-2\",\"check_type:api\",\"check_status:live\",\"ci_execution_rule:blocking\"],\"deleted\":null,\"query\":\"no_query\",\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"id\":102332053,\"multi\":false,\"name\":\"Test-Get_a_synthetics_monitor_s_details-1667899872\",\"created\":\"2022-11-08T09:31:13.159457+00:00\",\"created_at\":1667899873000,\"creator\":{\"id\":2781302,\"handle\":\"[email protected]\",\"name\":\"Frog\",\"email\":\"[email protected]\"},\"org_id\":569509,\"modified\":\"2022-11-08T09:31:13.159457+00:00\",\"priority\":5,\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"type\":\"synthetics alert\",\"options\":{\"notify_audit\":false,\"synthetics_check_id\":\"2ud-5q9-dwc\",\"silenced\":{},\"include_tags\":true,\"new_host_delay\":300,\"on_missing_data\":\"show_no_data\"}}\n"
+            "text": "{\"id\":103654710,\"org_id\":569509,\"type\":\"synthetics alert\",\"name\":\"Test-Get_a_synthetics_monitor_s_details-1669036841\",\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"tags\":[\"testing:api\",\"probe_dc:aws:us-east-2\",\"check_type:api\",\"check_status:live\",\"ci_execution_rule:blocking\"],\"query\":\"no_query\",\"options\":{\"include_tags\":true,\"notify_audit\":false,\"new_host_delay\":300,\"on_missing_data\":\"show_no_data\",\"synthetics_check_id\":\"ahw-qah-d9b\",\"silenced\":{}},\"multi\":false,\"created_at\":1669036841000,\"created\":\"2022-11-21T13:20:41.610325+00:00\",\"modified\":\"2022-11-21T13:20:41.610325+00:00\",\"deleted\":null,\"restricted_roles\":null,\"priority\":5,\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"creator\":{\"name\":\"Frog\",\"handle\":\"[email protected]\",\"email\":\"[email protected]\",\"id\":2781302}}\n"
           },
           "cookies": [],
           "headers": [
@@ -100,11 +100,11 @@
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2022-11-08T09:31:13.241Z",
-        "time": 361
+        "startedDateTime": "2022-11-21T13:20:41.700Z",
+        "time": 380
       },
       {
-        "_id": "abc4c92ebb30d612408ca4e000cef756",
+        "_id": "7a690f43b3f15a19388289e3e0281138",
         "_order": 0,
         "cache": {},
         "request": {
@@ -128,7 +128,7 @@
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"public_ids\":[\"2ud-5q9-dwc\"]}"
+            "text": "{\"public_ids\":[\"ahw-qah-d9b\"]}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v1/synthetics/tests/delete"
@@ -138,7 +138,7 @@
           "content": {
             "mimeType": "application/json",
             "size": 96,
-            "text": "{\"deleted_tests\":[{\"deleted_at\":\"2022-11-08T09:31:13.936142+00:00\",\"public_id\":\"2ud-5q9-dwc\"}]}\n"
+            "text": "{\"deleted_tests\":[{\"deleted_at\":\"2022-11-21T13:20:42.443854+00:00\",\"public_id\":\"ahw-qah-d9b\"}]}\n"
           },
           "cookies": [],
           "headers": [
@@ -153,8 +153,8 @@
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2022-11-08T09:31:13.610Z",
-        "time": 419
+        "startedDateTime": "2022-11-21T13:20:42.087Z",
+        "time": 505
       }
     ],
     "pages": [],

cassettes/v1/Synthetics_2658572017/Create-an-API-HTTP-test-returns-OK-Returns-the-created-test-details-response_3158393245/frozen.json

@@ -1 +1 @@
-"2022-11-07T13:42:32.570Z"
+"2022-11-14T14:48:36.716Z"