@@ -13366,60 +13366,11 @@ components:
13366
13366
$ref: '#/components/schemas/WidgetStyle'
13367
13367
type: object
13368
13368
SyntheticsAPIStep:
13369
- description: The steps used in a Synthetic multistep API test.
13370
- properties:
13371
- allowFailure:
13372
- description: Determines whether or not to continue with test if this step
13373
- fails.
13374
- type: boolean
13375
- assertions:
13376
- default: []
13377
- description: Array of assertions used for the test.
13378
- example:
13379
- - operator: lessThan
13380
- target: 1000
13381
- type: responseTime
13382
- items:
13383
- $ref: '#/components/schemas/SyntheticsAssertion'
13384
- type: array
13385
- extractedValues:
13386
- description: Array of values to parse and save as variables from the response.
13387
- items:
13388
- $ref: '#/components/schemas/SyntheticsParsingOptions'
13389
- type: array
13390
- isCritical:
13391
- description: 'Determines whether or not to consider the entire test as failed
13392
- if this step fails.
13393
-
13394
- Can be used only if `allowFailure` is `true`.'
13395
- type: boolean
13396
- name:
13397
- description: The name of the step.
13398
- example: Example step name
13399
- type: string
13400
- request:
13401
- $ref: '#/components/schemas/SyntheticsTestRequest'
13402
- retry:
13403
- $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
13404
- subtype:
13405
- $ref: '#/components/schemas/SyntheticsAPIStepSubtype'
13406
- required:
13407
- - assertions
13408
- - request
13409
- - name
13410
- - subtype
13369
+ description: The steps used in a Synthetic multi-step API test.
13370
+ oneOf:
13371
+ - $ref: '#/components/schemas/SyntheticsAPITestStep'
13372
+ - $ref: '#/components/schemas/SyntheticsAPIWaitStep'
13411
13373
type: object
13412
- SyntheticsAPIStepSubtype:
13413
- description: The subtype of the Synthetic multistep API test step, currently
13414
- only supporting `http`.
13415
- enum:
13416
- - http
13417
- - grpc
13418
- example: http
13419
- type: string
13420
- x-enum-varnames:
13421
- - HTTP
13422
- - GRPC
13423
13374
SyntheticsAPITest:
13424
13375
description: Object containing details about a Synthetic API test.
13425
13376
properties:
@@ -13608,6 +13559,60 @@ components:
13608
13559
timings:
13609
13560
$ref: '#/components/schemas/SyntheticsTiming'
13610
13561
type: object
13562
+ SyntheticsAPITestStep:
13563
+ description: The Test step used in a Synthetic multi-step API test.
13564
+ properties:
13565
+ allowFailure:
13566
+ description: Determines whether or not to continue with test if this step
13567
+ fails.
13568
+ type: boolean
13569
+ assertions:
13570
+ default: []
13571
+ description: Array of assertions used for the test.
13572
+ example:
13573
+ - operator: lessThan
13574
+ target: 1000
13575
+ type: responseTime
13576
+ items:
13577
+ $ref: '#/components/schemas/SyntheticsAssertion'
13578
+ type: array
13579
+ extractedValues:
13580
+ description: Array of values to parse and save as variables from the response.
13581
+ items:
13582
+ $ref: '#/components/schemas/SyntheticsParsingOptions'
13583
+ type: array
13584
+ isCritical:
13585
+ description: 'Determines whether or not to consider the entire test as failed
13586
+ if this step fails.
13587
+
13588
+ Can be used only if `allowFailure` is `true`.'
13589
+ type: boolean
13590
+ name:
13591
+ description: The name of the step.
13592
+ example: Example step name
13593
+ type: string
13594
+ request:
13595
+ $ref: '#/components/schemas/SyntheticsTestRequest'
13596
+ retry:
13597
+ $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
13598
+ subtype:
13599
+ $ref: '#/components/schemas/SyntheticsAPITestStepSubtype'
13600
+ required:
13601
+ - assertions
13602
+ - request
13603
+ - name
13604
+ - subtype
13605
+ type: object
13606
+ SyntheticsAPITestStepSubtype:
13607
+ description: The subtype of the Synthetic multi-step API test step.
13608
+ enum:
13609
+ - http
13610
+ - grpc
13611
+ example: http
13612
+ type: string
13613
+ x-enum-varnames:
13614
+ - HTTP
13615
+ - GRPC
13611
13616
SyntheticsAPITestType:
13612
13617
default: api
13613
13618
description: Type of the Synthetic test, `api`.
@@ -13617,6 +13622,36 @@ components:
13617
13622
type: string
13618
13623
x-enum-varnames:
13619
13624
- API
13625
+ SyntheticsAPIWaitStep:
13626
+ description: The Wait step used in a Synthetic multi-step API test.
13627
+ properties:
13628
+ name:
13629
+ description: The name of the step.
13630
+ example: Example step name
13631
+ type: string
13632
+ subtype:
13633
+ $ref: '#/components/schemas/SyntheticsAPIWaitStepSubtype'
13634
+ value:
13635
+ description: 'The time to wait in seconds. Minimum value: 0. Maximum value:
13636
+ 180.'
13637
+ example: 5
13638
+ format: int32
13639
+ maximum: 180
13640
+ minimum: 0
13641
+ type: integer
13642
+ required:
13643
+ - name
13644
+ - subtype
13645
+ - value
13646
+ type: object
13647
+ SyntheticsAPIWaitStepSubtype:
13648
+ description: The subtype of the Synthetic multi-step API wait step.
13649
+ enum:
13650
+ - wait
13651
+ example: wait
13652
+ type: string
13653
+ x-enum-varnames:
13654
+ - WAIT
13620
13655
SyntheticsApiTestFailureCode:
13621
13656
description: Error code that can be returned by a Synthetic test.
13622
13657
enum:
0 commit comments