@@ -15533,14 +15533,14 @@ components:
15533
15533
type: boolean
15534
15534
name:
15535
15535
description: The name of the step.
15536
+ example: example-name
15536
15537
maxLength: 1500
15537
15538
type: string
15538
15539
noScreenshot:
15539
15540
description: A boolean set to not take a screenshot for the step.
15540
15541
type: boolean
15541
15542
params:
15542
- description: The parameters of the mobile step.
15543
- type: object
15543
+ $ref: '#/components/schemas/SyntheticsMobileStepParams'
15544
15544
publicId:
15545
15545
description: The public ID of the step.
15546
15546
example: pub-lic-id0
@@ -15551,6 +15551,185 @@ components:
15551
15551
type: integer
15552
15552
type:
15553
15553
$ref: '#/components/schemas/SyntheticsMobileStepType'
15554
+ required:
15555
+ - name
15556
+ - params
15557
+ - type
15558
+ type: object
15559
+ SyntheticsMobileStepParams:
15560
+ description: The parameters of a mobile step.
15561
+ properties:
15562
+ check:
15563
+ $ref: '#/components/schemas/SyntheticsCheckType'
15564
+ delay:
15565
+ description: The `SyntheticsMobileStepParams` `delay`.
15566
+ format: int64
15567
+ maximum: 5000
15568
+ minimum: 0
15569
+ type: integer
15570
+ direction:
15571
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsDirection'
15572
+ element:
15573
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElement'
15574
+ enable:
15575
+ description: The `SyntheticsMobileStepParams` `enable`.
15576
+ type: boolean
15577
+ maxScrolls:
15578
+ description: The `SyntheticsMobileStepParams` `maxScrolls`.
15579
+ format: int64
15580
+ type: integer
15581
+ positions:
15582
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsPositions'
15583
+ subtestPublicId:
15584
+ description: The `SyntheticsMobileStepParams` `subtestPublicId`.
15585
+ type: string
15586
+ value:
15587
+ description: The `SyntheticsMobileStepParams` `value`.
15588
+ type: string
15589
+ variable:
15590
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsVariable'
15591
+ withEnter:
15592
+ description: The `SyntheticsMobileStepParams` `withEnter`.
15593
+ type: boolean
15594
+ x:
15595
+ description: The `SyntheticsMobileStepParams` `x`.
15596
+ format: int64
15597
+ type: integer
15598
+ y:
15599
+ description: The `SyntheticsMobileStepParams` `y`.
15600
+ format: int64
15601
+ type: integer
15602
+ type: object
15603
+ SyntheticsMobileStepParamsDirection:
15604
+ description: The definition of `SyntheticsMobileStepParamsDirection` object.
15605
+ enum:
15606
+ - up
15607
+ - down
15608
+ - left
15609
+ - right
15610
+ type: string
15611
+ x-enum-varnames:
15612
+ - UP
15613
+ - DOWN
15614
+ - LEFT
15615
+ - RIGHT
15616
+ SyntheticsMobileStepParamsElement:
15617
+ description: The definition of `SyntheticsMobileStepParamsElement` object.
15618
+ properties:
15619
+ context:
15620
+ description: The `element` `context`.
15621
+ type: string
15622
+ contextType:
15623
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementContextType'
15624
+ elementDescription:
15625
+ description: The `element` `elementDescription`.
15626
+ type: string
15627
+ multiLocator:
15628
+ description: The `element` `multiLocator`.
15629
+ type: object
15630
+ relativePosition:
15631
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition'
15632
+ textContent:
15633
+ description: The `element` `textContent`.
15634
+ type: string
15635
+ userLocator:
15636
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocator'
15637
+ viewName:
15638
+ description: The `element` `viewName`.
15639
+ type: string
15640
+ type: object
15641
+ SyntheticsMobileStepParamsElementContextType:
15642
+ description: The definition of `SyntheticsMobileStepParamsElementContextType`
15643
+ object.
15644
+ enum:
15645
+ - native
15646
+ - web
15647
+ type: string
15648
+ x-enum-varnames:
15649
+ - NATIVE
15650
+ - WEB
15651
+ SyntheticsMobileStepParamsElementRelativePosition:
15652
+ description: The definition of `SyntheticsMobileStepParamsElementRelativePosition`
15653
+ object.
15654
+ properties:
15655
+ x:
15656
+ description: The `relativePosition` `x`.
15657
+ format: int64
15658
+ type: integer
15659
+ y:
15660
+ description: The `relativePosition` `y`.
15661
+ format: int64
15662
+ type: integer
15663
+ type: object
15664
+ SyntheticsMobileStepParamsElementUserLocator:
15665
+ description: The definition of `SyntheticsMobileStepParamsElementUserLocator`
15666
+ object.
15667
+ properties:
15668
+ failTestOnCannotLocate:
15669
+ description: The `userLocator` `failTestOnCannotLocate`.
15670
+ type: boolean
15671
+ values:
15672
+ description: The `userLocator` `values`.
15673
+ items:
15674
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems'
15675
+ type: array
15676
+ type: object
15677
+ SyntheticsMobileStepParamsElementUserLocatorValuesItems:
15678
+ description: The definition of `SyntheticsMobileStepParamsElementUserLocatorValuesItems`
15679
+ object.
15680
+ properties:
15681
+ type:
15682
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType'
15683
+ value:
15684
+ description: The `SyntheticsMobileStepParamsElementUserLocatorValuesItems`
15685
+ `value`.
15686
+ type: string
15687
+ type: object
15688
+ SyntheticsMobileStepParamsElementUserLocatorValuesItemsType:
15689
+ description: The definition of `SyntheticsMobileStepParamsElementUserLocatorValuesItemsType`
15690
+ object.
15691
+ enum:
15692
+ - accessibility-id
15693
+ - id
15694
+ - ios-predicate-string
15695
+ - ios-class-chain
15696
+ - xpath
15697
+ type: string
15698
+ x-enum-varnames:
15699
+ - ACCESSIBILITY_ID
15700
+ - ID
15701
+ - IOS_PREDICATE_STRING
15702
+ - IOS_CLASS_CHAIN
15703
+ - XPATH
15704
+ SyntheticsMobileStepParamsPositions:
15705
+ description: The definition of `SyntheticsMobileStepParamsPositions` object.
15706
+ items:
15707
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsPositionsItems'
15708
+ type: array
15709
+ SyntheticsMobileStepParamsPositionsItems:
15710
+ description: The definition of `SyntheticsMobileStepParamsPositionsItems` object.
15711
+ properties:
15712
+ x:
15713
+ description: The `SyntheticsMobileStepParamsPositionsItems` `x`.
15714
+ format: int64
15715
+ type: integer
15716
+ y:
15717
+ description: The `SyntheticsMobileStepParamsPositionsItems` `y`.
15718
+ format: int64
15719
+ type: integer
15720
+ type: object
15721
+ SyntheticsMobileStepParamsVariable:
15722
+ description: The definition of `SyntheticsMobileStepParamsVariable` object.
15723
+ properties:
15724
+ example:
15725
+ description: The `variable` `example`.
15726
+ type: string
15727
+ name:
15728
+ description: The `variable` `name`.
15729
+ example: example-name
15730
+ type: string
15731
+ required:
15732
+ - name
15554
15733
type: object
15555
15734
SyntheticsMobileStepType:
15556
15735
description: Step type used in your mobile Synthetic test.
@@ -15648,42 +15827,28 @@ components:
15648
15827
type: object
15649
15828
SyntheticsMobileTestBinding:
15650
15829
description: Objects describing the binding used for a mobile test.
15651
- properties:
15652
- items:
15653
- $ref: '#/components/schemas/SyntheticsMobileTestBindingItems'
15654
- type: object
15655
- SyntheticsMobileTestBindingItems:
15656
- description: Object describing the binding used for a mobile test.
15657
15830
properties:
15658
15831
principals:
15659
15832
$ref: '#/components/schemas/SyntheticsMobileTestBindingPrincipals'
15660
- role :
15661
- $ref: '#/components/schemas/SyntheticsMobileTestBindingItemsRole '
15833
+ relation :
15834
+ $ref: '#/components/schemas/SyntheticsMobileTestBindingRelation '
15662
15835
type: object
15663
- SyntheticsMobileTestBindingItemsRole:
15664
- description: The definition of `SyntheticsMobileTestBindingItemsRole` object.
15665
- enum:
15666
- - editor
15667
- - viewer
15668
- type: string
15669
- x-enum-varnames:
15670
- - EDITOR
15671
- - VIEWER
15672
15836
SyntheticsMobileTestBindingPrincipals:
15673
15837
description: List of principals for a mobile test binding.
15674
15838
items:
15675
15839
description: A principal for a mobile test binding.
15676
15840
maxLength: 1500
15677
15841
type: string
15678
15842
type: array
15679
- SyntheticsMobileTestCiOptions:
15680
- description: CI/CD options for a Synthetic test.
15681
- properties:
15682
- executionRule:
15683
- $ref: '#/components/schemas/SyntheticsTestExecutionRule'
15684
- required:
15685
- - executionRule
15686
- type: object
15843
+ SyntheticsMobileTestBindingRelation:
15844
+ description: The definition of `SyntheticsMobileTestBindingRelation` object.
15845
+ enum:
15846
+ - editor
15847
+ - viewer
15848
+ type: string
15849
+ x-enum-varnames:
15850
+ - EDITOR
15851
+ - VIEWER
15687
15852
SyntheticsMobileTestConfig:
15688
15853
description: Configuration object for a Synthetic mobile test.
15689
15854
properties:
@@ -15696,18 +15861,10 @@ components:
15696
15861
type: array
15697
15862
type: object
15698
15863
SyntheticsMobileTestInitialApplicationArguments:
15864
+ additionalProperties:
15865
+ description: A single application argument.
15866
+ type: string
15699
15867
description: Initial application arguments for a mobile test.
15700
- properties:
15701
- propertyNames:
15702
- $ref: '#/components/schemas/SyntheticsMobileTestInitialApplicationArgumentsPropertyNames'
15703
- type: object
15704
- SyntheticsMobileTestInitialApplicationArgumentsPropertyNames:
15705
- description: Name of the property.
15706
- properties:
15707
- pattern:
15708
- description: The `propertyNames` `pattern`.
15709
- example: ^(?!_dd).*$
15710
- type: string
15711
15868
type: object
15712
15869
SyntheticsMobileTestOptions:
15713
15870
description: Object describing the extra options for a Synthetic test.
@@ -15721,7 +15878,7 @@ components:
15721
15878
$ref: '#/components/schemas/SyntheticsMobileTestBinding'
15722
15879
type: array
15723
15880
ci:
15724
- $ref: '#/components/schemas/SyntheticsMobileTestCiOptions '
15881
+ $ref: '#/components/schemas/SyntheticsTestCiOptions '
15725
15882
defaultStepTimeout:
15726
15883
description: The `SyntheticsMobileTestOptions` `defaultStepTimeout`.
15727
15884
format: int32
@@ -15731,6 +15888,8 @@ components:
15731
15888
device_ids:
15732
15889
description: For mobile test, array with the different device IDs used to
15733
15890
run the test.
15891
+ example:
15892
+ - synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16
15734
15893
items:
15735
15894
$ref: '#/components/schemas/SyntheticsMobileDeviceID'
15736
15895
type: array
@@ -15768,6 +15927,7 @@ components:
15768
15927
$ref: '#/components/schemas/SyntheticsTestOptionsScheduling'
15769
15928
tick_every:
15770
15929
description: The frequency at which to run the Synthetic test (in seconds).
15930
+ example: 300
15771
15931
format: int64
15772
15932
maximum: 604800
15773
15933
minimum: 300
@@ -15778,6 +15938,10 @@ components:
15778
15938
maximum: 5
15779
15939
minimum: 0
15780
15940
type: integer
15941
+ required:
15942
+ - device_ids
15943
+ - tick_every
15944
+ - mobileApplication
15781
15945
type: object
15782
15946
SyntheticsMobileTestOptionsMonitorOptions:
15783
15947
description: 'Object containing the options for a mobile Synthetic test as a
@@ -15830,21 +15994,28 @@ components:
15830
15994
properties:
15831
15995
applicationId:
15832
15996
description: Application ID of the mobile application.
15997
+ example: 00000000-0000-0000-0000-aaaaaaaaaaaa
15833
15998
maxLength: 1500
15834
15999
type: string
15835
16000
referenceId:
15836
16001
description: Reference ID of the mobile application.
16002
+ example: 00000000-0000-0000-0000-aaaaaaaaaaab
15837
16003
maxLength: 1500
15838
16004
type: string
15839
16005
referenceType:
15840
16006
$ref: '#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType'
16007
+ required:
16008
+ - applicationId
16009
+ - referenceId
16010
+ - referenceType
15841
16011
type: object
15842
16012
SyntheticsMobileTestsMobileApplicationReferenceType:
15843
16013
description: Reference type for the mobile application for a mobile synthetics
15844
16014
test.
15845
16015
enum:
15846
16016
- latest
15847
16017
- version
16018
+ example: latest
15848
16019
type: string
15849
16020
x-enum-varnames:
15850
16021
- LATEST
@@ -16313,6 +16484,8 @@ components:
16313
16484
properties:
16314
16485
executionRule:
16315
16486
$ref: '#/components/schemas/SyntheticsTestExecutionRule'
16487
+ required:
16488
+ - executionRule
16316
16489
type: object
16317
16490
SyntheticsTestConfig:
16318
16491
description: Configuration object for a Synthetic test.
@@ -16620,6 +16793,9 @@ components:
16620
16793
description: Timezone in which the timeframe is based.
16621
16794
example: America/New_York
16622
16795
type: string
16796
+ required:
16797
+ - timeframes
16798
+ - timezone
16623
16799
type: object
16624
16800
SyntheticsTestOptionsSchedulingTimeframe:
16625
16801
description: Object describing a timeframe.
@@ -16639,6 +16815,10 @@ components:
16639
16815
description: The hour of the day on which scheduling ends.
16640
16816
example: '16:00'
16641
16817
type: string
16818
+ required:
16819
+ - day
16820
+ - from
16821
+ - to
16642
16822
type: object
16643
16823
SyntheticsTestPauseStatus:
16644
16824
description: 'Define whether you want to start (`live`) or pause (`paused`)
0 commit comments