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