Regenerate client from commit 3ffafabe of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-18 21:00:59.110329",
-            "spec_repo_commit": "37070fd4"
+            "regenerated": "2024-10-21 13:14:35.827076",
+            "spec_repo_commit": "3ffafabe"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-18 21:00:59.128824",
-            "spec_repo_commit": "37070fd4"
+            "regenerated": "2024-10-21 13:14:35.845540",
+            "spec_repo_commit": "3ffafabe"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -15533,14 +15533,14 @@ components:
           type: boolean
         name:
           description: The name of the step.
+          example: example-name
           maxLength: 1500
           type: string
         noScreenshot:
           description: A boolean set to not take a screenshot for the step.
           type: boolean
         params:
-          description: The parameters of the mobile step.
-          type: object
+          $ref: '#/components/schemas/SyntheticsMobileStepParams'
         publicId:
           description: The public ID of the step.
           example: pub-lic-id0
@@ -15551,6 +15551,185 @@ components:
           type: integer
         type:
           $ref: '#/components/schemas/SyntheticsMobileStepType'
+      required:
+      - name
+      - params
+      - type
+      type: object
+    SyntheticsMobileStepParams:
+      description: The parameters of a mobile step.
+      properties:
+        check:
+          $ref: '#/components/schemas/SyntheticsCheckType'
+        delay:
+          description: The `SyntheticsMobileStepParams` `delay`.
+          format: int64
+          maximum: 5000
+          minimum: 0
+          type: integer
+        direction:
+          $ref: '#/components/schemas/SyntheticsMobileStepParamsDirection'
+        element:
+          $ref: '#/components/schemas/SyntheticsMobileStepParamsElement'
+        enable:
+          description: The `SyntheticsMobileStepParams` `enable`.
+          type: boolean
+        maxScrolls:
+          description: The `SyntheticsMobileStepParams` `maxScrolls`.
+          format: int64
+          type: integer
+        positions:
+          $ref: '#/components/schemas/SyntheticsMobileStepParamsPositions'
+        subtestPublicId:
+          description: The `SyntheticsMobileStepParams` `subtestPublicId`.
+          type: string
+        value:
+          description: The `SyntheticsMobileStepParams` `value`.
+          type: string
+        variable:
+          $ref: '#/components/schemas/SyntheticsMobileStepParamsVariable'
+        withEnter:
+          description: The `SyntheticsMobileStepParams` `withEnter`.
+          type: boolean
+        x:
+          description: The `SyntheticsMobileStepParams` `x`.
+          format: int64
+          type: integer
+        y:
+          description: The `SyntheticsMobileStepParams` `y`.
+          format: int64
+          type: integer
+      type: object
+    SyntheticsMobileStepParamsDirection:
+      description: The definition of `SyntheticsMobileStepParamsDirection` object.
+      enum:
+      - up
+      - down
+      - left
+      - right
+      type: string
+      x-enum-varnames:
+      - UP
+      - DOWN
+      - LEFT
+      - RIGHT
+    SyntheticsMobileStepParamsElement:
+      description: The definition of `SyntheticsMobileStepParamsElement` object.
+      properties:
+        context:
+          description: The `element` `context`.
+          type: string
+        contextType:
+          $ref: '#/components/schemas/SyntheticsMobileStepParamsElementContextType'
+        elementDescription:
+          description: The `element` `elementDescription`.
+          type: string
+        multiLocator:
+          description: The `element` `multiLocator`.
+          type: object
+        relativePosition:
+          $ref: '#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition'
+        textContent:
+          description: The `element` `textContent`.
+          type: string
+        userLocator:
+          $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocator'
+        viewName:
+          description: The `element` `viewName`.
+          type: string
+      type: object
+    SyntheticsMobileStepParamsElementContextType:
+      description: The definition of `SyntheticsMobileStepParamsElementContextType`
+        object.
+      enum:
+      - native
+      - web
+      type: string
+      x-enum-varnames:
+      - NATIVE
+      - WEB
+    SyntheticsMobileStepParamsElementRelativePosition:
+      description: The definition of `SyntheticsMobileStepParamsElementRelativePosition`
+        object.
+      properties:
+        x:
+          description: The `relativePosition` `x`.
+          format: int64
+          type: integer
+        y:
+          description: The `relativePosition` `y`.
+          format: int64
+          type: integer
+      type: object
+    SyntheticsMobileStepParamsElementUserLocator:
+      description: The definition of `SyntheticsMobileStepParamsElementUserLocator`
+        object.
+      properties:
+        failTestOnCannotLocate:
+          description: The `userLocator` `failTestOnCannotLocate`.
+          type: boolean
+        values:
+          description: The `userLocator` `values`.
+          items:
+            $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems'
+          type: array
+      type: object
+    SyntheticsMobileStepParamsElementUserLocatorValuesItems:
+      description: The definition of `SyntheticsMobileStepParamsElementUserLocatorValuesItems`
+        object.
+      properties:
+        type:
+          $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType'
+        value:
+          description: The `SyntheticsMobileStepParamsElementUserLocatorValuesItems`
+            `value`.
+          type: string
+      type: object
+    SyntheticsMobileStepParamsElementUserLocatorValuesItemsType:
+      description: The definition of `SyntheticsMobileStepParamsElementUserLocatorValuesItemsType`
+        object.
+      enum:
+      - accessibility-id
+      - id
+      - ios-predicate-string
+      - ios-class-chain
+      - xpath
+      type: string
+      x-enum-varnames:
+      - ACCESSIBILITY_ID
+      - ID
+      - IOS_PREDICATE_STRING
+      - IOS_CLASS_CHAIN
+      - XPATH
+    SyntheticsMobileStepParamsPositions:
+      description: The definition of `SyntheticsMobileStepParamsPositions` object.
+      items:
+        $ref: '#/components/schemas/SyntheticsMobileStepParamsPositionsItems'
+      type: array
+    SyntheticsMobileStepParamsPositionsItems:
+      description: The definition of `SyntheticsMobileStepParamsPositionsItems` object.
+      properties:
+        x:
+          description: The `SyntheticsMobileStepParamsPositionsItems` `x`.
+          format: int64
+          type: integer
+        y:
+          description: The `SyntheticsMobileStepParamsPositionsItems` `y`.
+          format: int64
+          type: integer
+      type: object
+    SyntheticsMobileStepParamsVariable:
+      description: The definition of `SyntheticsMobileStepParamsVariable` object.
+      properties:
+        example:
+          description: The `variable` `example`.
+          type: string
+        name:
+          description: The `variable` `name`.
+          example: example-name
+          type: string
+      required:
+      - name
       type: object
     SyntheticsMobileStepType:
       description: Step type used in your mobile Synthetic test.
@@ -15648,42 +15827,28 @@ components:
       type: object
     SyntheticsMobileTestBinding:
       description: Objects describing the binding used for a mobile test.
-      properties:
-        items:
-          $ref: '#/components/schemas/SyntheticsMobileTestBindingItems'
-      type: object
-    SyntheticsMobileTestBindingItems:
-      description: Object describing the binding used for a mobile test.
       properties:
         principals:
           $ref: '#/components/schemas/SyntheticsMobileTestBindingPrincipals'
-        role:
-          $ref: '#/components/schemas/SyntheticsMobileTestBindingItemsRole'
+        relation:
+          $ref: '#/components/schemas/SyntheticsMobileTestBindingRelation'
       type: object
-    SyntheticsMobileTestBindingItemsRole:
-      description: The definition of `SyntheticsMobileTestBindingItemsRole` object.
-      enum:
-      - editor
-      - viewer
-      type: string
-      x-enum-varnames:
-      - EDITOR
-      - VIEWER
     SyntheticsMobileTestBindingPrincipals:
       description: List of principals for a mobile test binding.
       items:
         description: A principal for a mobile test binding.
         maxLength: 1500
         type: string
       type: array
-    SyntheticsMobileTestCiOptions:
-      description: CI/CD options for a Synthetic test.
-      properties:
-        executionRule:
-          $ref: '#/components/schemas/SyntheticsTestExecutionRule'
-      required:
-      - executionRule
-      type: object
+    SyntheticsMobileTestBindingRelation:
+      description: The definition of `SyntheticsMobileTestBindingRelation` object.
+      enum:
+      - editor
+      - viewer
+      type: string
+      x-enum-varnames:
+      - EDITOR
+      - VIEWER
     SyntheticsMobileTestConfig:
       description: Configuration object for a Synthetic mobile test.
       properties:
@@ -15696,18 +15861,10 @@ components:
           type: array
       type: object
     SyntheticsMobileTestInitialApplicationArguments:
+      additionalProperties:
+        description: A single application argument.
+        type: string
       description: Initial application arguments for a mobile test.
-      properties:
-        propertyNames:
-          $ref: '#/components/schemas/SyntheticsMobileTestInitialApplicationArgumentsPropertyNames'
-      type: object
-    SyntheticsMobileTestInitialApplicationArgumentsPropertyNames:
-      description: Name of the property.
-      properties:
-        pattern:
-          description: The `propertyNames` `pattern`.
-          example: ^(?!_dd).*$
-          type: string
       type: object
     SyntheticsMobileTestOptions:
       description: Object describing the extra options for a Synthetic test.
@@ -15721,7 +15878,7 @@ components:
             $ref: '#/components/schemas/SyntheticsMobileTestBinding'
           type: array
         ci:
-          $ref: '#/components/schemas/SyntheticsMobileTestCiOptions'
+          $ref: '#/components/schemas/SyntheticsTestCiOptions'
         defaultStepTimeout:
           description: The `SyntheticsMobileTestOptions` `defaultStepTimeout`.
           format: int32
@@ -15731,6 +15888,8 @@ components:
         device_ids:
           description: For mobile test, array with the different device IDs used to
             run the test.
+          example:
+          - synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16
           items:
             $ref: '#/components/schemas/SyntheticsMobileDeviceID'
           type: array
@@ -15768,6 +15927,7 @@ components:
           $ref: '#/components/schemas/SyntheticsTestOptionsScheduling'
         tick_every:
           description: The frequency at which to run the Synthetic test (in seconds).
+          example: 300
           format: int64
           maximum: 604800
           minimum: 300
@@ -15778,6 +15938,10 @@ components:
           maximum: 5
           minimum: 0
           type: integer
+      required:
+      - device_ids
+      - tick_every
+      - mobileApplication
       type: object
     SyntheticsMobileTestOptionsMonitorOptions:
       description: 'Object containing the options for a mobile Synthetic test as a
@@ -15830,21 +15994,28 @@ components:
       properties:
         applicationId:
           description: Application ID of the mobile application.
+          example: 00000000-0000-0000-0000-aaaaaaaaaaaa
           maxLength: 1500
           type: string
         referenceId:
           description: Reference ID of the mobile application.
+          example: 00000000-0000-0000-0000-aaaaaaaaaaab
           maxLength: 1500
           type: string
         referenceType:
           $ref: '#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType'
+      required:
+      - applicationId
+      - referenceId
+      - referenceType
       type: object
     SyntheticsMobileTestsMobileApplicationReferenceType:
       description: Reference type for the mobile application for a mobile synthetics
         test.
       enum:
       - latest
       - version
+      example: latest
       type: string
       x-enum-varnames:
       - LATEST
@@ -16313,6 +16484,8 @@ components:
       properties:
         executionRule:
           $ref: '#/components/schemas/SyntheticsTestExecutionRule'
+      required:
+      - executionRule
       type: object
     SyntheticsTestConfig:
       description: Configuration object for a Synthetic test.
@@ -16620,6 +16793,9 @@ components:
           description: Timezone in which the timeframe is based.
           example: America/New_York
           type: string
+      required:
+      - timeframes
+      - timezone
       type: object
     SyntheticsTestOptionsSchedulingTimeframe:
       description: Object describing a timeframe.
@@ -16639,6 +16815,10 @@ components:
           description: The hour of the day on which scheduling ends.
           example: '16:00'
           type: string
+      required:
+      - day
+      - from
+      - to
       type: object
     SyntheticsTestPauseStatus:
       description: 'Define whether you want to start (`live`) or pause (`paused`)