Remove steps from certain expected synthetics api response (#3214)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

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

.generator/schemas/v1/openapi.yaml

@@ -16582,7 +16582,7 @@ components:
         tests:
           description: Array of Synthetic tests configuration.
           items:
-            $ref: '#/components/schemas/SyntheticsTestDetails'
+            $ref: '#/components/schemas/SyntheticsTestDetailsWithoutSteps'
           type: array
       type: object
     SyntheticsLocalVariableParsingOptionsType:
@@ -17613,7 +17613,7 @@ components:
         status:
           $ref: '#/components/schemas/SyntheticsTestPauseStatus'
         steps:
-          description: For browser test, the steps of the test.
+          description: The steps of the test if they exist.
           items:
             $ref: '#/components/schemas/SyntheticsStep'
           type: array
@@ -17665,6 +17665,52 @@ components:
       - API
       - BROWSER
       - MOBILE
+    SyntheticsTestDetailsWithoutSteps:
+      description: Object containing details about your Synthetic test, without test
+        steps.
+      properties:
+        config:
+          $ref: '#/components/schemas/SyntheticsTestConfig'
+        creator:
+          $ref: '#/components/schemas/Creator'
+        locations:
+          description: Array of locations used to run the test.
+          example:
+          - aws:eu-west-3
+          items:
+            description: A location from which the test was run.
+            type: string
+          type: array
+        message:
+          description: Notification message associated with the test.
+          type: string
+        monitor_id:
+          description: The associated monitor ID.
+          format: int64
+          readOnly: true
+          type: integer
+        name:
+          description: Name of the test.
+          type: string
+        options:
+          $ref: '#/components/schemas/SyntheticsTestOptions'
+        public_id:
+          description: The test public ID.
+          readOnly: true
+          type: string
+        status:
+          $ref: '#/components/schemas/SyntheticsTestPauseStatus'
+        subtype:
+          $ref: '#/components/schemas/SyntheticsTestDetailsSubType'
+        tags:
+          description: Array of tags attached to the test.
+          items:
+            description: A tag attached to the test.
+            type: string
+          type: array
+        type:
+          $ref: '#/components/schemas/SyntheticsTestDetailsType'
+      type: object
     SyntheticsTestExecutionRule:
       description: Execution rule for a Synthetic test.
       enum:
@@ -35257,7 +35303,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/SyntheticsTestDetails'
+                $ref: '#/components/schemas/SyntheticsTestDetailsWithoutSteps'
           description: OK
         '403':
           content:

private/bdd_runner/src/support/scenarios_model_mapping.ts

@@ -2168,7 +2168,7 @@ export const ScenariosModelMappings: { [key: string]: OperationMapping } = {
       type: "string",
       format: "",
     },
-    operationResponseType: "SyntheticsTestDetails",
+    operationResponseType: "SyntheticsTestDetailsWithoutSteps",
   },
   "SyntheticsApi.V1.PatchTest": {
     publicId: {

services/synthetics/src/v1/SyntheticsApi.ts

@@ -44,6 +44,7 @@ import { SyntheticsPatchTestBody } from "./models/SyntheticsPatchTestBody";
 import { SyntheticsPrivateLocation } from "./models/SyntheticsPrivateLocation";
 import { SyntheticsPrivateLocationCreationResponse } from "./models/SyntheticsPrivateLocationCreationResponse";
 import { SyntheticsTestDetails } from "./models/SyntheticsTestDetails";
+import { SyntheticsTestDetailsWithoutSteps } from "./models/SyntheticsTestDetailsWithoutSteps";
 import { SyntheticsTestUptime } from "./models/SyntheticsTestUptime";
 import { SyntheticsTriggerBody } from "./models/SyntheticsTriggerBody";
 import { SyntheticsTriggerCITestsResponse } from "./models/SyntheticsTriggerCITestsResponse";
@@ -3073,14 +3074,14 @@ export class SyntheticsApiResponseProcessor {
    */
   public async getTest(
     response: ResponseContext,
-  ): Promise<SyntheticsTestDetails> {
+  ): Promise<SyntheticsTestDetailsWithoutSteps> {
     const contentType = normalizeMediaType(response.headers["content-type"]);
     if (response.httpStatusCode === 200) {
-      const body: SyntheticsTestDetails = deserialize(
+      const body: SyntheticsTestDetailsWithoutSteps = deserialize(
         parse(await response.body.text(), contentType),
         TypingInfo,
-        "SyntheticsTestDetails",
-      ) as SyntheticsTestDetails;
+        "SyntheticsTestDetailsWithoutSteps",
+      ) as SyntheticsTestDetailsWithoutSteps;
       return body;
     }
     if (
@@ -3108,12 +3109,12 @@ export class SyntheticsApiResponseProcessor {
 
     // Work around for missing responses in specification, e.g. for petstore.yaml
     if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
-      const body: SyntheticsTestDetails = deserialize(
+      const body: SyntheticsTestDetailsWithoutSteps = deserialize(
         parse(await response.body.text(), contentType),
         TypingInfo,
-        "SyntheticsTestDetails",
+        "SyntheticsTestDetailsWithoutSteps",
         "",
-      ) as SyntheticsTestDetails;
+      ) as SyntheticsTestDetailsWithoutSteps;
       return body;
     }
 
@@ -4670,7 +4671,7 @@ export class SyntheticsApi {
   public getTest(
     param: SyntheticsApiGetTestRequest,
     options?: Configuration,
-  ): Promise<SyntheticsTestDetails> {
+  ): Promise<SyntheticsTestDetailsWithoutSteps> {
     const requestContextPromise = this.requestFactory.getTest(
       param.publicId,
       options,
@@ -4746,7 +4747,7 @@ export class SyntheticsApi {
   public async *listTestsWithPagination(
     param: SyntheticsApiListTestsRequest = {},
     options?: Configuration,
-  ): AsyncGenerator<SyntheticsTestDetails> {
+  ): AsyncGenerator<SyntheticsTestDetailsWithoutSteps> {
     let pageSize = 100;
     if (param.pageSize !== undefined) {
       pageSize = param.pageSize;

services/synthetics/src/v1/index.ts

@@ -181,6 +181,7 @@ export { SyntheticsTestConfig } from "./models/SyntheticsTestConfig";
 export { SyntheticsTestDetails } from "./models/SyntheticsTestDetails";
 export { SyntheticsTestDetailsSubType } from "./models/SyntheticsTestDetailsSubType";
 export { SyntheticsTestDetailsType } from "./models/SyntheticsTestDetailsType";
+export { SyntheticsTestDetailsWithoutSteps } from "./models/SyntheticsTestDetailsWithoutSteps";
 export { SyntheticsTestExecutionRule } from "./models/SyntheticsTestExecutionRule";
 export { SyntheticsTestMonitorStatus } from "./models/SyntheticsTestMonitorStatus";
 export { SyntheticsTestOptions } from "./models/SyntheticsTestOptions";

services/synthetics/src/v1/models/SyntheticsListTestsResponse.ts

@@ -1,6 +1,6 @@
 import { AttributeTypeMap } from "@datadog/datadog-api-client";
 
-import { SyntheticsTestDetails } from "./SyntheticsTestDetails";
+import { SyntheticsTestDetailsWithoutSteps } from "./SyntheticsTestDetailsWithoutSteps";
 
 /**
  * Object containing an array of Synthetic tests configuration.
@@ -9,7 +9,7 @@ export class SyntheticsListTestsResponse {
   /**
    * Array of Synthetic tests configuration.
    */
-  "tests"?: Array<SyntheticsTestDetails>;
+  "tests"?: Array<SyntheticsTestDetailsWithoutSteps>;
   /**
    * A container for additional, undeclared properties.
    * This is a holder for any undeclared properties as specified with
@@ -27,7 +27,7 @@ export class SyntheticsListTestsResponse {
   static readonly attributeTypeMap: AttributeTypeMap = {
     tests: {
       baseName: "tests",
-      type: "Array<SyntheticsTestDetails>",
+      type: "Array<SyntheticsTestDetailsWithoutSteps>",
     },
     additionalProperties: {
       baseName: "additionalProperties",

services/synthetics/src/v1/models/SyntheticsTestDetails.ts

@@ -50,7 +50,7 @@ export class SyntheticsTestDetails {
    */
   "status"?: SyntheticsTestPauseStatus;
   /**
-   * For browser test, the steps of the test.
+   * The steps of the test if they exist.
    */
   "steps"?: Array<SyntheticsStep>;
   /**

services/synthetics/src/v1/models/SyntheticsTestDetailsWithoutSteps.ts

@@ -0,0 +1,142 @@
+import { AttributeTypeMap } from "@datadog/datadog-api-client";
+
+import { Creator } from "./Creator";
+import { SyntheticsTestConfig } from "./SyntheticsTestConfig";
+import { SyntheticsTestDetailsSubType } from "./SyntheticsTestDetailsSubType";
+import { SyntheticsTestDetailsType } from "./SyntheticsTestDetailsType";
+import { SyntheticsTestOptions } from "./SyntheticsTestOptions";
+import { SyntheticsTestPauseStatus } from "./SyntheticsTestPauseStatus";
+
+/**
+ * Object containing details about your Synthetic test, without test steps.
+ */
+export class SyntheticsTestDetailsWithoutSteps {
+  /**
+   * Configuration object for a Synthetic test.
+   */
+  "config"?: SyntheticsTestConfig;
+  /**
+   * Object describing the creator of the shared element.
+   */
+  "creator"?: Creator;
+  /**
+   * Array of locations used to run the test.
+   */
+  "locations"?: Array<string>;
+  /**
+   * Notification message associated with the test.
+   */
+  "message"?: string;
+  /**
+   * The associated monitor ID.
+   */
+  "monitorId"?: number;
+  /**
+   * Name of the test.
+   */
+  "name"?: string;
+  /**
+   * Object describing the extra options for a Synthetic test.
+   */
+  "options"?: SyntheticsTestOptions;
+  /**
+   * The test public ID.
+   */
+  "publicId"?: string;
+  /**
+   * Define whether you want to start (`live`) or pause (`paused`) a
+   * Synthetic test.
+   */
+  "status"?: SyntheticsTestPauseStatus;
+  /**
+   * The subtype of the Synthetic API test, `http`, `ssl`, `tcp`,
+   * `dns`, `icmp`, `udp`, `websocket`, `grpc` or `multi`.
+   */
+  "subtype"?: SyntheticsTestDetailsSubType;
+  /**
+   * Array of tags attached to the test.
+   */
+  "tags"?: Array<string>;
+  /**
+   * Type of the Synthetic test, either `api` or `browser`.
+   */
+  "type"?: SyntheticsTestDetailsType;
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    config: {
+      baseName: "config",
+      type: "SyntheticsTestConfig",
+    },
+    creator: {
+      baseName: "creator",
+      type: "Creator",
+    },
+    locations: {
+      baseName: "locations",
+      type: "Array<string>",
+    },
+    message: {
+      baseName: "message",
+      type: "string",
+    },
+    monitorId: {
+      baseName: "monitor_id",
+      type: "number",
+      format: "int64",
+    },
+    name: {
+      baseName: "name",
+      type: "string",
+    },
+    options: {
+      baseName: "options",
+      type: "SyntheticsTestOptions",
+    },
+    publicId: {
+      baseName: "public_id",
+      type: "string",
+    },
+    status: {
+      baseName: "status",
+      type: "SyntheticsTestPauseStatus",
+    },
+    subtype: {
+      baseName: "subtype",
+      type: "SyntheticsTestDetailsSubType",
+    },
+    tags: {
+      baseName: "tags",
+      type: "Array<string>",
+    },
+    type: {
+      baseName: "type",
+      type: "SyntheticsTestDetailsType",
+    },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "{ [key: string]: any; }",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return SyntheticsTestDetailsWithoutSteps.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

services/synthetics/src/v1/models/TypingInfo.ts

@@ -100,6 +100,7 @@ import { SyntheticsStepDetailWarning } from "./SyntheticsStepDetailWarning";
 import { SyntheticsTestCiOptions } from "./SyntheticsTestCiOptions";
 import { SyntheticsTestConfig } from "./SyntheticsTestConfig";
 import { SyntheticsTestDetails } from "./SyntheticsTestDetails";
+import { SyntheticsTestDetailsWithoutSteps } from "./SyntheticsTestDetailsWithoutSteps";
 import { SyntheticsTestOptions } from "./SyntheticsTestOptions";
 import { SyntheticsTestOptionsMonitorOptions } from "./SyntheticsTestOptionsMonitorOptions";
 import { SyntheticsTestOptionsRetry } from "./SyntheticsTestOptionsRetry";
@@ -538,6 +539,7 @@ export const TypingInfo: ModelTypingInfo = {
     SyntheticsTestCiOptions: SyntheticsTestCiOptions,
     SyntheticsTestConfig: SyntheticsTestConfig,
     SyntheticsTestDetails: SyntheticsTestDetails,
+    SyntheticsTestDetailsWithoutSteps: SyntheticsTestDetailsWithoutSteps,
     SyntheticsTestOptions: SyntheticsTestOptions,
     SyntheticsTestOptionsMonitorOptions: SyntheticsTestOptionsMonitorOptions,
     SyntheticsTestOptionsRetry: SyntheticsTestOptionsRetry,