Update Synthetics CI test metadata (#311)

* Delete SyntheticsCITestMetadataCi.ts

* Regenerate client from commit 5a8a968 of spec repo

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

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-11-02 14:05:28.344809",
-            "spec_repo_commit": "ca6b2d8"
+            "regenerated": "2021-11-03 12:23:56.257041",
+            "spec_repo_commit": "5a8a968"
         },
         "v2": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-11-02 14:05:28.371028",
-            "spec_repo_commit": "ca6b2d8"
+            "regenerated": "2021-11-03 12:23:56.280638",
+            "spec_repo_commit": "5a8a968"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -9846,22 +9846,34 @@ components:
       description: Description of the CI provider.
       properties:
         pipeline:
-          description: Name of the pipeline.
-          type: string
+          $ref: '#/components/schemas/SyntheticsCIBatchMetadataPipeline'
         provider:
-          description: Name of the CI provider.
-          type: string
+          $ref: '#/components/schemas/SyntheticsCIBatchMetadataProvider'
       type: object
     SyntheticsCIBatchMetadataGit:
       description: Git information.
       properties:
         branch:
           description: The branch name.
           type: string
-        commit_sha:
+        commitSha:
           description: The commit SHA.
           type: string
       type: object
+    SyntheticsCIBatchMetadataPipeline:
+      description: Description of the CI pipeline.
+      properties:
+        url:
+          description: URL of the pipeline.
+          type: string
+      type: object
+    SyntheticsCIBatchMetadataProvider:
+      description: Description of the CI provider.
+      properties:
+        name:
+          description: Name of the CI provider.
+          type: string
+      type: object
     SyntheticsCITest:
       description: Test configuration for Synthetics CI
       properties:
@@ -10659,7 +10671,8 @@ components:
       properties:
         assertions:
           default: []
-          description: Array of assertions used for the test.
+          description: Array of assertions used for the test. Required for single
+            API tests.
           example: []
           items:
             $ref: '#/components/schemas/SyntheticsAssertion'

docs/v1/SyntheticsApi.md

@@ -1592,8 +1592,12 @@ let params: v1.SyntheticsApiTriggerCITestsRequest = {
         locations: ["locations_example"],
         metadata: {
           ci: {
-            pipeline: "pipeline_example",
-            provider: "provider_example",
+            pipeline: {
+              url: "url_example",
+            },
+            provider: {
+              name: "name_example",
+            },
           },
           git: {
             branch: "branch_example",

features/v1/synthetics.feature

@@ -442,13 +442,13 @@ Feature: Synthetics
   @generated @skip
   Scenario: Trigger tests from CI/CD pipelines returns "JSON format is wrong" response
     Given new "TriggerCITests" request
-    And body with value {"tests": [{"allowInsecureCertificates": null, "basicAuth": {"password": "", "username": ""}, "body": null, "bodyType": null, "cookies": null, "deviceIds": ["laptop_large"], "followRedirects": null, "headers": null, "locations": [null], "metadata": {"ci": {"pipeline": null, "provider": null}, "git": {"branch": null, "commit_sha": null}}, "public_id": "aaa-aaa-aaa", "retry": {"count": null, "interval": null}, "startUrl": null, "variables": null}]}
+    And body with value {"tests": [{"allowInsecureCertificates": null, "basicAuth": {"password": "", "username": ""}, "body": null, "bodyType": null, "cookies": null, "deviceIds": ["laptop_large"], "followRedirects": null, "headers": null, "locations": [null], "metadata": {"ci": {"pipeline": {"url": null}, "provider": {"name": null}}, "git": {"branch": null, "commitSha": null}}, "public_id": "aaa-aaa-aaa", "retry": {"count": null, "interval": null}, "startUrl": null, "variables": null}]}
     When the request is sent
     Then the response status is 400 JSON format is wrong
 
   @generated @skip
   Scenario: Trigger tests from CI/CD pipelines returns "OK" response
     Given new "TriggerCITests" request
-    And body with value {"tests": [{"allowInsecureCertificates": null, "basicAuth": {"password": "", "username": ""}, "body": null, "bodyType": null, "cookies": null, "deviceIds": ["laptop_large"], "followRedirects": null, "headers": null, "locations": [null], "metadata": {"ci": {"pipeline": null, "provider": null}, "git": {"branch": null, "commit_sha": null}}, "public_id": "aaa-aaa-aaa", "retry": {"count": null, "interval": null}, "startUrl": null, "variables": null}]}
+    And body with value {"tests": [{"allowInsecureCertificates": null, "basicAuth": {"password": "", "username": ""}, "body": null, "bodyType": null, "cookies": null, "deviceIds": ["laptop_large"], "followRedirects": null, "headers": null, "locations": [null], "metadata": {"ci": {"pipeline": {"url": null}, "provider": {"name": null}}, "git": {"branch": null, "commitSha": null}}, "public_id": "aaa-aaa-aaa", "retry": {"count": null, "interval": null}, "startUrl": null, "variables": null}]}
     When the request is sent
     Then the response status is 200 OK

packages/datadog-api-client-v1/.openapi-generator/FILES

@@ -483,6 +483,8 @@ models/SyntheticsBrowserVariableType.ts
 models/SyntheticsCIBatchMetadata.ts
 models/SyntheticsCIBatchMetadataCI.ts
 models/SyntheticsCIBatchMetadataGit.ts
+models/SyntheticsCIBatchMetadataPipeline.ts
+models/SyntheticsCIBatchMetadataProvider.ts
 models/SyntheticsCITest.ts
 models/SyntheticsCITestBody.ts
 models/SyntheticsCheckType.ts

packages/datadog-api-client-v1/models/ObjectSerializer.ts

@@ -310,6 +310,8 @@ import { SyntheticsBrowserVariable } from "./SyntheticsBrowserVariable";
 import { SyntheticsCIBatchMetadata } from "./SyntheticsCIBatchMetadata";
 import { SyntheticsCIBatchMetadataCI } from "./SyntheticsCIBatchMetadataCI";
 import { SyntheticsCIBatchMetadataGit } from "./SyntheticsCIBatchMetadataGit";
+import { SyntheticsCIBatchMetadataPipeline } from "./SyntheticsCIBatchMetadataPipeline";
+import { SyntheticsCIBatchMetadataProvider } from "./SyntheticsCIBatchMetadataProvider";
 import { SyntheticsCITest } from "./SyntheticsCITest";
 import { SyntheticsCITestBody } from "./SyntheticsCITestBody";
 import { SyntheticsConfigVariable } from "./SyntheticsConfigVariable";
@@ -969,6 +971,8 @@ const typeMap: { [index: string]: any } = {
   SyntheticsCIBatchMetadata: SyntheticsCIBatchMetadata,
   SyntheticsCIBatchMetadataCI: SyntheticsCIBatchMetadataCI,
   SyntheticsCIBatchMetadataGit: SyntheticsCIBatchMetadataGit,
+  SyntheticsCIBatchMetadataPipeline: SyntheticsCIBatchMetadataPipeline,
+  SyntheticsCIBatchMetadataProvider: SyntheticsCIBatchMetadataProvider,
   SyntheticsCITest: SyntheticsCITest,
   SyntheticsCITestBody: SyntheticsCITestBody,
   SyntheticsConfigVariable: SyntheticsConfigVariable,

packages/datadog-api-client-v1/models/SyntheticsCIBatchMetadataCI.ts

@@ -8,21 +8,17 @@
  * Do not edit the class manually.
  */
 
+import { SyntheticsCIBatchMetadataPipeline } from "./SyntheticsCIBatchMetadataPipeline";
+import { SyntheticsCIBatchMetadataProvider } from "./SyntheticsCIBatchMetadataProvider";
 import { ObjectSerializer } from "./ObjectSerializer";
 
 /**
  * Description of the CI provider.
  */
 
 export class SyntheticsCIBatchMetadataCI {
-  /**
-   * Name of the pipeline.
-   */
-  "pipeline"?: string;
-  /**
-   * Name of the CI provider.
-   */
-  "provider"?: string;
+  "pipeline"?: SyntheticsCIBatchMetadataPipeline;
+  "provider"?: SyntheticsCIBatchMetadataProvider;
 
   "unparsedObject"?: any;
 
@@ -33,12 +29,12 @@ export class SyntheticsCIBatchMetadataCI {
   } = {
     pipeline: {
       baseName: "pipeline",
-      type: "string",
+      type: "SyntheticsCIBatchMetadataPipeline",
       format: "",
     },
     provider: {
       baseName: "provider",
-      type: "string",
+      type: "SyntheticsCIBatchMetadataProvider",
       format: "",
     },
   };
@@ -52,9 +48,17 @@ export class SyntheticsCIBatchMetadataCI {
   }): SyntheticsCIBatchMetadataCI {
     const res = new SyntheticsCIBatchMetadataCI();
 
-    res.pipeline = ObjectSerializer.deserialize(data.pipeline, "string", "");
+    res.pipeline = ObjectSerializer.deserialize(
+      data.pipeline,
+      "SyntheticsCIBatchMetadataPipeline",
+      ""
+    );
 
-    res.provider = ObjectSerializer.deserialize(data.provider, "string", "");
+    res.provider = ObjectSerializer.deserialize(
+      data.provider,
+      "SyntheticsCIBatchMetadataProvider",
+      ""
+    );
 
     return res;
   }
@@ -70,9 +74,17 @@ export class SyntheticsCIBatchMetadataCI {
     if (data?.unparsedObject !== undefined) {
       return data.unparsedObject;
     }
-    res.pipeline = ObjectSerializer.serialize(data.pipeline, "string", "");
+    res.pipeline = ObjectSerializer.serialize(
+      data.pipeline,
+      "SyntheticsCIBatchMetadataPipeline",
+      ""
+    );
 
-    res.provider = ObjectSerializer.serialize(data.provider, "string", "");
+    res.provider = ObjectSerializer.serialize(
+      data.provider,
+      "SyntheticsCIBatchMetadataProvider",
+      ""
+    );
 
     return res;
   }

packages/datadog-api-client-v1/models/SyntheticsCIBatchMetadataGit.ts

@@ -37,7 +37,7 @@ export class SyntheticsCIBatchMetadataGit {
       format: "",
     },
     commitSha: {
-      baseName: "commit_sha",
+      baseName: "commitSha",
       type: "string",
       format: "",
     },
@@ -54,7 +54,7 @@ export class SyntheticsCIBatchMetadataGit {
 
     res.branch = ObjectSerializer.deserialize(data.branch, "string", "");
 
-    res.commitSha = ObjectSerializer.deserialize(data.commit_sha, "string", "");
+    res.commitSha = ObjectSerializer.deserialize(data.commitSha, "string", "");
 
     return res;
   }
@@ -72,7 +72,7 @@ export class SyntheticsCIBatchMetadataGit {
     }
     res.branch = ObjectSerializer.serialize(data.branch, "string", "");
 
-    res.commit_sha = ObjectSerializer.serialize(data.commitSha, "string", "");
+    res.commitSha = ObjectSerializer.serialize(data.commitSha, "string", "");
 
     return res;
   }

packages/datadog-api-client-v1/models/SyntheticsCIBatchMetadataPipeline.ts

@@ -0,0 +1,71 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { ObjectSerializer } from "./ObjectSerializer";
+
+/**
+ * Description of the CI pipeline.
+ */
+
+export class SyntheticsCIBatchMetadataPipeline {
+  /**
+   * URL of the pipeline.
+   */
+  "url"?: string;
+
+  "unparsedObject"?: any;
+
+  static readonly discriminator: string | undefined = undefined;
+
+  static readonly attributeTypeMap: {
+    [key: string]: { baseName: string; type: string; format: string };
+  } = {
+    url: {
+      baseName: "url",
+      type: "string",
+      format: "",
+    },
+  };
+
+  static getAttributeTypeMap() {
+    return SyntheticsCIBatchMetadataPipeline.attributeTypeMap;
+  }
+
+  static deserialize(data: {
+    [key: string]: any;
+  }): SyntheticsCIBatchMetadataPipeline {
+    const res = new SyntheticsCIBatchMetadataPipeline();
+
+    res.url = ObjectSerializer.deserialize(data.url, "string", "");
+
+    return res;
+  }
+
+  static serialize(data: SyntheticsCIBatchMetadataPipeline): {
+    [key: string]: any;
+  } {
+    const attributeTypes =
+      SyntheticsCIBatchMetadataPipeline.getAttributeTypeMap();
+    const res: { [index: string]: any } = {};
+    for (const [key, value] of Object.entries(data)) {
+      if (!(key in attributeTypes)) {
+        throw new TypeError(`${key} attribute not in schema`);
+      }
+    }
+    if (data?.unparsedObject !== undefined) {
+      return data.unparsedObject;
+    }
+    res.url = ObjectSerializer.serialize(data.url, "string", "");
+
+    return res;
+  }
+
+  public constructor() {}
+}

packages/datadog-api-client-v1/models/SyntheticsCIBatchMetadataProvider.ts

@@ -0,0 +1,71 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { ObjectSerializer } from "./ObjectSerializer";
+
+/**
+ * Description of the CI provider.
+ */
+
+export class SyntheticsCIBatchMetadataProvider {
+  /**
+   * Name of the CI provider.
+   */
+  "name"?: string;
+
+  "unparsedObject"?: any;
+
+  static readonly discriminator: string | undefined = undefined;
+
+  static readonly attributeTypeMap: {
+    [key: string]: { baseName: string; type: string; format: string };
+  } = {
+    name: {
+      baseName: "name",
+      type: "string",
+      format: "",
+    },
+  };
+
+  static getAttributeTypeMap() {
+    return SyntheticsCIBatchMetadataProvider.attributeTypeMap;
+  }
+
+  static deserialize(data: {
+    [key: string]: any;
+  }): SyntheticsCIBatchMetadataProvider {
+    const res = new SyntheticsCIBatchMetadataProvider();
+
+    res.name = ObjectSerializer.deserialize(data.name, "string", "");
+
+    return res;
+  }
+
+  static serialize(data: SyntheticsCIBatchMetadataProvider): {
+    [key: string]: any;
+  } {
+    const attributeTypes =
+      SyntheticsCIBatchMetadataProvider.getAttributeTypeMap();
+    const res: { [index: string]: any } = {};
+    for (const [key, value] of Object.entries(data)) {
+      if (!(key in attributeTypes)) {
+        throw new TypeError(`${key} attribute not in schema`);
+      }
+    }
+    if (data?.unparsedObject !== undefined) {
+      return data.unparsedObject;
+    }
+    res.name = ObjectSerializer.serialize(data.name, "string", "");
+
+    return res;
+  }
+
+  public constructor() {}
+}