Skip to content

Commit

Permalink
Add option for wait step in multistep api tests (#2543)
Browse files Browse the repository at this point in the history
Co-authored-by: ci.datadog-api-spec <[email protected]>
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec authored Jul 1, 2024
1 parent a820285 commit 4d5ffad
Show file tree
Hide file tree
Showing 16 changed files with 926 additions and 534 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-06-27 21:40:22.807790",
"spec_repo_commit": "4ed44e4c"
"regenerated": "2024-07-01 12:39:38.860700",
"spec_repo_commit": "f54c0bf3"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-06-27 21:40:22.826839",
"spec_repo_commit": "4ed44e4c"
"regenerated": "2024-07-01 12:39:38.879260",
"spec_repo_commit": "f54c0bf3"
}
}
}
141 changes: 88 additions & 53 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13366,60 +13366,11 @@ components:
$ref: '#/components/schemas/WidgetStyle'
type: object
SyntheticsAPIStep:
description: The steps used in a Synthetic multistep API test.
properties:
allowFailure:
description: Determines whether or not to continue with test if this step
fails.
type: boolean
assertions:
default: []
description: Array of assertions used for the test.
example:
- operator: lessThan
target: 1000
type: responseTime
items:
$ref: '#/components/schemas/SyntheticsAssertion'
type: array
extractedValues:
description: Array of values to parse and save as variables from the response.
items:
$ref: '#/components/schemas/SyntheticsParsingOptions'
type: array
isCritical:
description: 'Determines whether or not to consider the entire test as failed
if this step fails.

Can be used only if `allowFailure` is `true`.'
type: boolean
name:
description: The name of the step.
example: Example step name
type: string
request:
$ref: '#/components/schemas/SyntheticsTestRequest'
retry:
$ref: '#/components/schemas/SyntheticsTestOptionsRetry'
subtype:
$ref: '#/components/schemas/SyntheticsAPIStepSubtype'
required:
- assertions
- request
- name
- subtype
description: The steps used in a Synthetic multi-step API test.
oneOf:
- $ref: '#/components/schemas/SyntheticsAPITestStep'
- $ref: '#/components/schemas/SyntheticsAPIWaitStep'
type: object
SyntheticsAPIStepSubtype:
description: The subtype of the Synthetic multistep API test step, currently
only supporting `http`.
enum:
- http
- grpc
example: http
type: string
x-enum-varnames:
- HTTP
- GRPC
SyntheticsAPITest:
description: Object containing details about a Synthetic API test.
properties:
Expand Down Expand Up @@ -13608,6 +13559,60 @@ components:
timings:
$ref: '#/components/schemas/SyntheticsTiming'
type: object
SyntheticsAPITestStep:
description: The Test step used in a Synthetic multi-step API test.
properties:
allowFailure:
description: Determines whether or not to continue with test if this step
fails.
type: boolean
assertions:
default: []
description: Array of assertions used for the test.
example:
- operator: lessThan
target: 1000
type: responseTime
items:
$ref: '#/components/schemas/SyntheticsAssertion'
type: array
extractedValues:
description: Array of values to parse and save as variables from the response.
items:
$ref: '#/components/schemas/SyntheticsParsingOptions'
type: array
isCritical:
description: 'Determines whether or not to consider the entire test as failed
if this step fails.

Can be used only if `allowFailure` is `true`.'
type: boolean
name:
description: The name of the step.
example: Example step name
type: string
request:
$ref: '#/components/schemas/SyntheticsTestRequest'
retry:
$ref: '#/components/schemas/SyntheticsTestOptionsRetry'
subtype:
$ref: '#/components/schemas/SyntheticsAPITestStepSubtype'
required:
- assertions
- request
- name
- subtype
type: object
SyntheticsAPITestStepSubtype:
description: The subtype of the Synthetic multi-step API test step.
enum:
- http
- grpc
example: http
type: string
x-enum-varnames:
- HTTP
- GRPC
SyntheticsAPITestType:
default: api
description: Type of the Synthetic test, `api`.
Expand All @@ -13617,6 +13622,36 @@ components:
type: string
x-enum-varnames:
- API
SyntheticsAPIWaitStep:
description: The Wait step used in a Synthetic multi-step API test.
properties:
name:
description: The name of the step.
example: Example step name
type: string
subtype:
$ref: '#/components/schemas/SyntheticsAPIWaitStepSubtype'
value:
description: 'The time to wait in seconds. Minimum value: 0. Maximum value:
180.'
example: 5
format: int32
maximum: 180
minimum: 0
type: integer
required:
- name
- subtype
- value
type: object
SyntheticsAPIWaitStepSubtype:
description: The subtype of the Synthetic multi-step API wait step.
enum:
- wait
example: wait
type: string
x-enum-varnames:
- WAIT
SyntheticsApiTestFailureCode:
description: Error code that can be returned by a Synthetic test.
enum:
Expand Down
Loading

0 comments on commit 4d5ffad

Please sign in to comment.