Add JSONSchema assertion support to API and multistep tests (#1576)

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.6",
-            "regenerated": "2024-04-19 20:49:41.651088",
-            "spec_repo_commit": "c3db9ec1"
+            "regenerated": "2024-04-22 11:29:46.702337",
+            "spec_repo_commit": "0f37d2e6"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-19 20:49:41.669675",
-            "spec_repo_commit": "c3db9ec1"
+            "regenerated": "2024-04-22 11:29:46.720414",
+            "spec_repo_commit": "0f37d2e6"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -13627,6 +13627,7 @@ components:
       oneOf:
       - $ref: '#/components/schemas/SyntheticsAssertionTarget'
       - $ref: '#/components/schemas/SyntheticsAssertionJSONPathTarget'
+      - $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaTarget'
       - $ref: '#/components/schemas/SyntheticsAssertionXPathTarget'
     SyntheticsAssertionJSONPathOperator:
       description: Assertion operator to apply.
@@ -13664,6 +13665,45 @@ components:
         targetValue:
           description: The path target value to compare to.
       type: object
+    SyntheticsAssertionJSONSchemaMetaSchema:
+      description: The JSON Schema meta-schema version used in the assertion.
+      enum:
+      - draft-07
+      - draft-06
+      type: string
+      x-enum-varnames:
+      - DRAFT_07
+      - DRAFT_06
+    SyntheticsAssertionJSONSchemaOperator:
+      description: Assertion operator to apply.
+      enum:
+      - validatesJSONSchema
+      example: validatesJSONSchema
+      type: string
+      x-enum-varnames:
+      - VALIDATES_JSON_SCHEMA
+    SyntheticsAssertionJSONSchemaTarget:
+      description: An assertion for the `validatesJSONSchema` operator.
+      properties:
+        operator:
+          $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaOperator'
+        target:
+          $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaTargetTarget'
+        type:
+          $ref: '#/components/schemas/SyntheticsAssertionType'
+      required:
+      - type
+      - operator
+      type: object
+    SyntheticsAssertionJSONSchemaTargetTarget:
+      description: Composed target for `validatesJSONSchema` operator.
+      properties:
+        jsonSchema:
+          description: The JSON Schema to assert.
+          type: string
+        metaSchema:
+          $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaMetaSchema'
+      type: object
     SyntheticsAssertionOperator:
       description: Assertion operator to apply.
       enum:

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

@@ -1 +1 @@
-"2024-04-17T12:11:38.797Z"
+"2024-04-19T18:06:11.007Z"

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

@@ -8,11 +8,11 @@
     },
     "entries": [
       {
-        "_id": "1341da1bcc02b2f592e0d99b2c6bd7d6",
+        "_id": "7aa96dd034502a3c894d2c24f6af4b28",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 1753,
+          "bodySize": 1929,
           "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,\"timingsScope\":\"withoutDNS\",\"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\":\"testgetasyntheticsmonitorsdetails1713355898\"},\"method\":\"GET\",\"persistCookies\":true,\"proxy\":{\"headers\":{},\"url\":\"https://datadoghq.com\"},\"timeout\":10,\"url\":\"https://datadoghq.com\"},\"variablesFromScript\":\"dd.variable.set(\\\"FOO\\\", \\\"foo\\\")\"},\"locations\":[\"aws:us-east-2\"],\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"name\":\"Test-Get_a_synthetics_monitor_s_details-1713355898\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"httpVersion\":\"http2\",\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Get_a_synthetics_monitor_s_details-1713355898\",\"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,\"timingsScope\":\"withoutDNS\",\"type\":\"responseTime\"},{\"operator\":\"validatesJSONPath\",\"target\":{\"jsonPath\":\"topKey\",\"operator\":\"isNot\",\"targetValue\":\"0\"},\"type\":\"body\"},{\"operator\":\"validatesJSONSchema\",\"target\":{\"jsonSchema\":\"{\\\"type\\\": \\\"object\\\", \\\"properties\\\":{\\\"slideshow\\\":{\\\"type\\\":\\\"object\\\"}}}\",\"metaSchema\":\"draft-07\"},\"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\":\"testgetasyntheticsmonitorsdetails1713549971\"},\"method\":\"GET\",\"persistCookies\":true,\"proxy\":{\"headers\":{},\"url\":\"https://datadoghq.com\"},\"timeout\":10,\"url\":\"https://datadoghq.com\"},\"variablesFromScript\":\"dd.variable.set(\\\"FOO\\\", \\\"foo\\\")\"},\"locations\":[\"aws:us-east-2\"],\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"name\":\"Test-Get_a_synthetics_monitor_s_details-1713549971\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"httpVersion\":\"http2\",\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Get_a_synthetics_monitor_s_details-1713549971\",\"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": 2168,
+          "bodySize": 2250,
           "content": {
             "mimeType": "application/json",
-            "size": 2168,
-            "text": "{\"public_id\":\"9b9-pwq-ged\",\"name\":\"Test-Get_a_synthetics_monitor_s_details-1713355898\",\"status\":\"live\",\"type\":\"api\",\"tags\":[\"testing:api\"],\"created_at\":\"2024-04-17T12:11:39.111595+00:00\",\"modified_at\":\"2024-04-17T12:11:39.111595+00:00\",\"config\":{\"assertions\":[{\"operator\":\"is\",\"property\":\"{{ PROPERTY }}\",\"target\":\"text/html\",\"type\":\"header\"},{\"operator\":\"lessThan\",\"target\":2000,\"timingsScope\":\"withoutDNS\",\"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\":{\"filename\":\"cert-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"},\"key\":{\"filename\":\"key-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"}},\"headers\":{\"unique\":\"testgetasyntheticsmonitorsdetails1713355898\"},\"method\":\"GET\",\"persistCookies\":true,\"proxy\":{\"headers\":{},\"url\":\"https://datadoghq.com\"},\"timeout\":10,\"url\":\"https://datadoghq.com\"},\"variablesFromScript\":\"dd.variable.set(\\\"FOO\\\", \\\"foo\\\")\"},\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"httpVersion\":\"http2\",\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Get_a_synthetics_monitor_s_details-1713355898\",\"monitor_priority\":5,\"retry\":{\"count\":3,\"interval\":10},\"tick_every\":60},\"locations\":[\"aws:us-east-2\"],\"subtype\":\"http\",\"created_by\":{\"name\":\"CI Account\",\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"email\":\"[email protected]\"},\"deleted_at\":null,\"monitor_id\":143340067,\"org_id\":321813,\"modified_by\":{\"name\":\"CI Account\",\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"email\":\"[email protected]\"}}"
+            "size": 2250,
+            "text": "{\"public_id\":\"vp2-ewh-gtm\",\"name\":\"Test-Get_a_synthetics_monitor_s_details-1713549971\",\"status\":\"live\",\"type\":\"api\",\"tags\":[\"testing:api\"],\"created_at\":\"2024-04-19T18:06:11.424005+00:00\",\"modified_at\":\"2024-04-19T18:06:11.424005+00:00\",\"config\":{\"assertions\":[{\"operator\":\"is\",\"property\":\"{{ PROPERTY }}\",\"target\":\"text/html\",\"type\":\"header\"},{\"operator\":\"lessThan\",\"target\":2000,\"timingsScope\":\"withoutDNS\",\"type\":\"responseTime\"},{\"operator\":\"validatesJSONPath\",\"target\":{\"jsonPath\":\"topKey\",\"operator\":\"isNot\",\"targetValue\":\"0\"},\"type\":\"body\"},{\"operator\":\"validatesJSONSchema\",\"target\":{\"jsonSchema\":\"{\\\"type\\\": \\\"object\\\", \\\"properties\\\":{\\\"slideshow\\\":{\\\"type\\\":\\\"object\\\"}}}\",\"metaSchema\":\"draft-07\"},\"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\":{\"filename\":\"cert-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"},\"key\":{\"filename\":\"key-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"}},\"headers\":{\"unique\":\"testgetasyntheticsmonitorsdetails1713549971\"},\"method\":\"GET\",\"persistCookies\":true,\"proxy\":{\"headers\":{},\"url\":\"https://datadoghq.com\"},\"timeout\":10,\"url\":\"https://datadoghq.com\"},\"variablesFromScript\":\"dd.variable.set(\\\"FOO\\\", \\\"foo\\\")\"},\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"httpVersion\":\"http2\",\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Get_a_synthetics_monitor_s_details-1713549971\",\"monitor_priority\":5,\"retry\":{\"count\":3,\"interval\":10},\"tick_every\":60},\"locations\":[\"aws:us-east-2\"],\"subtype\":\"http\",\"created_by\":{\"name\":null,\"handle\":\"[email protected]\",\"email\":\"[email protected]\"},\"deleted_at\":null,\"monitor_id\":143517846,\"org_id\":321813,\"modified_by\":{\"name\":null,\"handle\":\"[email protected]\",\"email\":\"[email protected]\"}}"
           },
           "cookies": [],
           "headers": [
@@ -57,11 +57,11 @@
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2024-04-17T12:11:38.816Z",
-        "time": 986
+        "startedDateTime": "2024-04-19T18:06:11.016Z",
+        "time": 1030
       },
       {
-        "_id": "90d9ffe82454bf30ec5dcd226e3bfede",
+        "_id": "d7158b31439a3c401c8067048fccbcd7",
         "_order": 0,
         "cache": {},
         "request": {
@@ -78,14 +78,14 @@
           "httpVersion": "HTTP/1.1",
           "method": "GET",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v1/monitor/143340067"
+          "url": "https://api.datadoghq.com/api/v1/monitor/143517846"
         },
         "response": {
-          "bodySize": 860,
+          "bodySize": 813,
           "content": {
             "mimeType": "application/json",
-            "size": 860,
-            "text": "{\"id\":143340067,\"org_id\":321813,\"type\":\"synthetics alert\",\"name\":\"Test-Get_a_synthetics_monitor_s_details-1713355898\",\"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\":{\"on_missing_data\":\"show_no_data\",\"notify_audit\":false,\"new_host_delay\":300,\"include_tags\":true,\"synthetics_check_id\":\"9b9-pwq-ged\",\"silenced\":{}},\"multi\":false,\"created_at\":1713355899000,\"created\":\"2024-04-17T12:11:39.064494+00:00\",\"modified\":\"2024-04-17T12:11:39.064494+00:00\",\"deleted\":null,\"restricted_roles\":null,\"priority\":5,\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"creator\":{\"name\":\"CI Account\",\"email\":\"team-intg-tools-libs-spam@datadoghq.com\",\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"id\":2320499}}\n"
+            "size": 813,
+            "text": "{\"id\":143517846,\"org_id\":321813,\"type\":\"synthetics alert\",\"name\":\"Test-Get_a_synthetics_monitor_s_details-1713549971\",\"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\":{\"on_missing_data\":\"show_no_data\",\"notify_audit\":false,\"new_host_delay\":300,\"include_tags\":true,\"synthetics_check_id\":\"vp2-ewh-gtm\",\"silenced\":{}},\"multi\":false,\"created_at\":1713549971000,\"created\":\"2024-04-19T18:06:11.399838+00:00\",\"modified\":\"2024-04-19T18:06:11.399838+00:00\",\"deleted\":null,\"restricted_roles\":null,\"priority\":5,\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"creator\":{\"name\":null,\"email\":\"frog@datadoghq.com\",\"handle\":\"[email protected]\",\"id\":1445416}}\n"
           },
           "cookies": [],
           "headers": [
@@ -100,11 +100,11 @@
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2024-04-17T12:11:39.811Z",
-        "time": 109
+        "startedDateTime": "2024-04-19T18:06:12.066Z",
+        "time": 133
       },
       {
-        "_id": "9a565d42a589fd22aea0b111665fcd2b",
+        "_id": "d91b960d151f7644a8cb97817f796bd2",
         "_order": 0,
         "cache": {},
         "request": {
@@ -128,7 +128,7 @@
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"public_ids\":[\"9b9-pwq-ged\"]}"
+            "text": "{\"public_ids\":[\"vp2-ewh-gtm\"]}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v1/synthetics/tests/delete"
@@ -138,7 +138,7 @@
           "content": {
             "mimeType": "application/json",
             "size": 96,
-            "text": "{\"deleted_tests\":[{\"public_id\":\"9b9-pwq-ged\",\"deleted_at\":\"2024-04-17T12:11:40.255350+00:00\"}]}\n"
+            "text": "{\"deleted_tests\":[{\"public_id\":\"vp2-ewh-gtm\",\"deleted_at\":\"2024-04-19T18:06:12.668857+00:00\"}]}\n"
           },
           "cookies": [],
           "headers": [
@@ -153,8 +153,8 @@
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2024-04-17T12:11:39.926Z",
-        "time": 1012
+        "startedDateTime": "2024-04-19T18:06:12.219Z",
+        "time": 542
       }
     ],
     "pages": [],

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

@@ -1 +1 @@
-"2024-04-17T12:11:41.063Z"
+"2024-04-19T18:06:12.804Z"