Add persistCookies option synthetics test request (#1931)

Co-authored-by: ci.datadog-api-spec <[email protected]>
DataDog · Aug 14, 2023 · a71520f · a71520f
1 parent dd85a5c
commit a71520f
Show file tree

Hide file tree

Showing 14 changed files with 78 additions and 45 deletions.
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-11 17:09:04.774339",
-            "spec_repo_commit": "0b6bfbed"
+            "regenerated": "2023-08-11 18:45:42.989487",
+            "spec_repo_commit": "54e2961f"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-11 17:09:04.792492",
-            "spec_repo_commit": "0b6bfbed"
+            "regenerated": "2023-08-11 18:45:43.006040",
+            "spec_repo_commit": "54e2961f"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -14664,6 +14664,9 @@ components:
           maximum: 10
           minimum: 0
           type: integer
+        persistCookies:
+          description: Persist cookies across redirects.
+          type: boolean
         port:
           description: Port to use when performing the test.
           format: int64

diff --git a/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.java b/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.java
@@ -115,7 +115,8 @@ public static void main(String[] args) {
                                         .scope("yoyo")
                                         .tokenApiAuthentication(
                                             SyntheticsBasicAuthOauthTokenApiAuthentication.HEADER)
-                                        .type(SyntheticsBasicAuthOauthClientType.OAUTH_CLIENT)))))
+                                        .type(SyntheticsBasicAuthOauthClientType.OAUTH_CLIENT)))
+                            .persistCookies(true)))
             .locations(Collections.singletonList("aws:us-east-2"))
             .message("BDD test payload: synthetics_api_http_test_payload.json")
             .name("Example-Synthetic")

diff --git a/src/main/java/com/datadog/api/client/v1/model/SyntheticsTestRequest.java b/src/main/java/com/datadog/api/client/v1/model/SyntheticsTestRequest.java
@@ -38,6 +38,7 @@
   SyntheticsTestRequest.JSON_PROPERTY_METHOD,
   SyntheticsTestRequest.JSON_PROPERTY_NO_SAVING_RESPONSE_BODY,
   SyntheticsTestRequest.JSON_PROPERTY_NUMBER_OF_PACKETS,
+  SyntheticsTestRequest.JSON_PROPERTY_PERSIST_COOKIES,
   SyntheticsTestRequest.JSON_PROPERTY_PORT,
   SyntheticsTestRequest.JSON_PROPERTY_PROXY,
   SyntheticsTestRequest.JSON_PROPERTY_QUERY,
@@ -105,6 +106,9 @@ public class SyntheticsTestRequest {
   public static final String JSON_PROPERTY_NUMBER_OF_PACKETS = "numberOfPackets";
   private Integer numberOfPackets;
 
+  public static final String JSON_PROPERTY_PERSIST_COOKIES = "persistCookies";
+  private Boolean persistCookies;
+
   public static final String JSON_PROPERTY_PORT = "port";
   private Long port;
 
@@ -545,6 +549,27 @@ public void setNumberOfPackets(Integer numberOfPackets) {
     this.numberOfPackets = numberOfPackets;
   }
 
+  public SyntheticsTestRequest persistCookies(Boolean persistCookies) {
+    this.persistCookies = persistCookies;
+    return this;
+  }
+
+  /**
+   * Persist cookies across redirects.
+   *
+   * @return persistCookies
+   */
+  @jakarta.annotation.Nullable
+  @JsonProperty(JSON_PROPERTY_PERSIST_COOKIES)
+  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  public Boolean getPersistCookies() {
+    return persistCookies;
+  }
+
+  public void setPersistCookies(Boolean persistCookies) {
+    this.persistCookies = persistCookies;
+  }
+
   public SyntheticsTestRequest port(Long port) {
     this.port = port;
     return this;
@@ -791,6 +816,7 @@ public boolean equals(Object o) {
         && Objects.equals(this.method, syntheticsTestRequest.method)
         && Objects.equals(this.noSavingResponseBody, syntheticsTestRequest.noSavingResponseBody)
         && Objects.equals(this.numberOfPackets, syntheticsTestRequest.numberOfPackets)
+        && Objects.equals(this.persistCookies, syntheticsTestRequest.persistCookies)
         && Objects.equals(this.port, syntheticsTestRequest.port)
         && Objects.equals(this.proxy, syntheticsTestRequest.proxy)
         && Objects.equals(this.query, syntheticsTestRequest.query)
@@ -823,6 +849,7 @@ public int hashCode() {
         method,
         noSavingResponseBody,
         numberOfPackets,
+        persistCookies,
         port,
         proxy,
         query,
@@ -860,6 +887,7 @@ public String toString() {
         .append(toIndentedString(noSavingResponseBody))
         .append("\n");
     sb.append("    numberOfPackets: ").append(toIndentedString(numberOfPackets)).append("\n");
+    sb.append("    persistCookies: ").append(toIndentedString(persistCookies)).append("\n");
     sb.append("    port: ").append(toIndentedString(port)).append("\n");
     sb.append("    proxy: ").append(toIndentedString(proxy)).append("\n");
     sb.append("    query: ").append(toIndentedString(query)).append("\n");

diff --git a/...es/v1/Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response.freeze b/...es/v1/Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response.freeze
@@ -1 +1 @@
-2023-01-11T22:23:00.967Z
+2023-08-11T15:25:10.265Z
diff --git a/...ures/v1/Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response.json b/...ures/v1/Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response.json
@@ -3,7 +3,7 @@
     "httpRequest": {
       "body": {
         "type": "JSON",
-        "json": "{\"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\":\"testcreateanapihttptestreturnsokreturnsthecreatedtestdetailsresponse1673475780\"},\"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_test_returns_OK_Returns_the_created_test_details_response-1673475780\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"httpVersion\":\"http2\",\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response-1673475780\",\"monitor_priority\":5,\"retry\":{\"count\":3,\"interval\":10},\"tick_every\":60},\"subtype\":\"http\",\"tags\":[\"testing:api\"],\"type\":\"api\"}"
+        "json": "{\"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\":\"testcreateanapihttptestreturnsokreturnsthecreatedtestdetailsresponse1691767510\"},\"method\":\"GET\",\"persistCookies\":true,\"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_test_returns_OK_Returns_the_created_test_details_response-1691767510\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"httpVersion\":\"http2\",\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response-1691767510\",\"monitor_priority\":5,\"retry\":{\"count\":3,\"interval\":10},\"tick_every\":60},\"subtype\":\"http\",\"tags\":[\"testing:api\"],\"type\":\"api\"}"
       },
       "headers": {},
       "method": "POST",
@@ -12,7 +12,7 @@
       "secure": true
     },
     "httpResponse": {
-      "body": "{\"status\":\"live\",\"public_id\":\"v95-t96-e52\",\"tags\":[\"testing:api\"],\"org_id\":321813,\"locations\":[\"aws:us-east-2\"],\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"deleted_at\":null,\"name\":\"Test-Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response-1673475780\",\"monitor_id\":107572226,\"type\":\"api\",\"created_at\":\"2023-01-11T22:23:01.221860+00:00\",\"modified_at\":\"2023-01-11T22:23:01.221860+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\":\"testcreateanapihttptestreturnsokreturnsthecreatedtestdetailsresponse1673475780\"},\"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_test_returns_OK_Returns_the_created_test_details_response-1673475780\",\"tick_every\":60,\"httpVersion\":\"http2\"}}",
+      "body": "{\"public_id\":\"p5t-6vv-3xj\",\"name\":\"Test-Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response-1691767510\",\"status\":\"live\",\"type\":\"api\",\"tags\":[\"testing:api\"],\"created_at\":\"2023-08-11T15:25:10.474768+00:00\",\"modified_at\":\"2023-08-11T15:25:10.474768+00:00\",\"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\":{\"filename\":\"cert-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"},\"key\":{\"filename\":\"key-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"}},\"headers\":{\"unique\":\"testcreateanapihttptestreturnsokreturnsthecreatedtestdetailsresponse1691767510\"},\"method\":\"GET\",\"persistCookies\":true,\"proxy\":{\"headers\":{},\"url\":\"https://datadoghq.com\"},\"timeout\":10,\"url\":\"https://datadoghq.com\"}},\"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-Create_an_API_HTTP_test_returns_OK_Returns_the_created_test_details_response-1691767510\",\"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\":128997418,\"org_id\":321813,\"modified_by\":{\"name\":null,\"handle\":\"[email protected]\",\"email\":\"[email protected]\"}}",
       "headers": {
         "Content-Type": [
           "application/json"
@@ -27,13 +27,13 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "babbe6bf-a82c-0a8b-d8bc-34d385c9ec07"
+    "id": "1fdc9975-447f-f41d-6d73-f0f1b22d5624"
   },
   {
     "httpRequest": {
       "body": {
         "type": "JSON",
-        "json": "{\"public_ids\":[\"v95-t96-e52\"]}"
+        "json": "{\"public_ids\":[\"p5t-6vv-3xj\"]}"
       },
       "headers": {},
       "method": "POST",
@@ -42,7 +42,7 @@
       "secure": true
     },
     "httpResponse": {
-      "body": "{\"deleted_tests\":[{\"deleted_at\":\"2023-01-11T22:23:01.652785+00:00\",\"public_id\":\"v95-t96-e52\"}]}\n",
+      "body": "{\"deleted_tests\":[{\"public_id\":\"p5t-6vv-3xj\",\"deleted_at\":\"2023-08-11T15:25:10.679107+00:00\"}]}\n",
       "headers": {
         "Content-Type": [
           "application/json"
@@ -57,6 +57,6 @@
     "timeToLive": {
       "unlimited": true
     },
-    "id": "227b77a7-aed6-9858-747f-1f7eabb5629f"
+    "id": "c8cbc8b1-1c92-7cd5-0f9e-c0ffc04fcc70"
   }
 ]
diff --git a/src/test/resources/cassettes/features/v1/Edit_an_API_test_returns_OK_response.freeze b/src/test/resources/cassettes/features/v1/Edit_an_API_test_returns_OK_response.freeze
@@ -1 +1 @@
-2023-01-11T22:27:11.207Z
+2023-08-11T15:25:10.775Z