Skip to content

Commit 949b000

Browse files
api-clients-generation-pipeline[bot]jirikuncarci.datadog-api-spec
authored
Add support for multistep tests in Synthetics (#313)
* rm old tests * Regenerate client from commit ce24aad of spec repo Co-authored-by: Jiri Kuncar <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent e69394c commit 949b000

24 files changed

+900
-59
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.4.1.dev8",
7-
"regenerated": "2021-03-08 11:24:06.929024",
8-
"spec_repo_commit": "a75da1e"
7+
"regenerated": "2021-03-08 16:50:32.502804",
8+
"spec_repo_commit": "ce24aad"
99
},
1010
"v2": {
1111
"apigentools_version": "1.4.1.dev8",
12-
"regenerated": "2021-03-08 11:24:44.205548",
13-
"spec_repo_commit": "a75da1e"
12+
"regenerated": "2021-03-08 16:51:11.736074",
13+
"spec_repo_commit": "ce24aad"
1414
}
1515
}
1616
}

‎docs/v1/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -562,6 +562,8 @@ Class | Method | HTTP request | Description
562562
- [SlackIntegrationChannel](SlackIntegrationChannel.md)
563563
- [SlackIntegrationChannelDisplay](SlackIntegrationChannelDisplay.md)
564564
- [SlackIntegrationChannels](SlackIntegrationChannels.md)
565+
- [SyntheticsAPIStep](SyntheticsAPIStep.md)
566+
- [SyntheticsAPIStepSubtype](SyntheticsAPIStepSubtype.md)
565567
- [SyntheticsAPITest](SyntheticsAPITest.md)
566568
- [SyntheticsAPITestConfig](SyntheticsAPITestConfig.md)
567569
- [SyntheticsAPITestResultData](SyntheticsAPITestResultData.md)
@@ -609,13 +611,13 @@ Class | Method | HTTP request | Description
609611
- [SyntheticsGetBrowserTestLatestResultsResponse](SyntheticsGetBrowserTestLatestResultsResponse.md)
610612
- [SyntheticsGlobalVariable](SyntheticsGlobalVariable.md)
611613
- [SyntheticsGlobalVariableParseTestOptions](SyntheticsGlobalVariableParseTestOptions.md)
612-
- [SyntheticsGlobalVariableParseTestOptionsParser](SyntheticsGlobalVariableParseTestOptionsParser.md)
613614
- [SyntheticsGlobalVariableParseTestOptionsType](SyntheticsGlobalVariableParseTestOptionsType.md)
614615
- [SyntheticsGlobalVariableParserType](SyntheticsGlobalVariableParserType.md)
615616
- [SyntheticsGlobalVariableValue](SyntheticsGlobalVariableValue.md)
616617
- [SyntheticsListTestsResponse](SyntheticsListTestsResponse.md)
617618
- [SyntheticsLocation](SyntheticsLocation.md)
618619
- [SyntheticsLocations](SyntheticsLocations.md)
620+
- [SyntheticsParsingOptions](SyntheticsParsingOptions.md)
619621
- [SyntheticsPlayingTab](SyntheticsPlayingTab.md)
620622
- [SyntheticsPrivateLocation](SyntheticsPrivateLocation.md)
621623
- [SyntheticsPrivateLocationCreationResponse](SyntheticsPrivateLocationCreationResponse.md)
@@ -650,6 +652,7 @@ Class | Method | HTTP request | Description
650652
- [SyntheticsTriggerCITestRunResult](SyntheticsTriggerCITestRunResult.md)
651653
- [SyntheticsTriggerCITestsResponse](SyntheticsTriggerCITestsResponse.md)
652654
- [SyntheticsUpdateTestPauseStatusPayload](SyntheticsUpdateTestPauseStatusPayload.md)
655+
- [SyntheticsVariableParser](SyntheticsVariableParser.md)
653656
- [SyntheticsWarningType](SyntheticsWarningType.md)
654657
- [TableWidgetCellDisplayMode](TableWidgetCellDisplayMode.md)
655658
- [TableWidgetDefinition](TableWidgetDefinition.md)

‎docs/v1/SyntheticsAPIStep.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# SyntheticsAPIStep
2+
3+
The steps used in a Synthetics multistep API test.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**assertions** | [**[SyntheticsAssertion]**](SyntheticsAssertion.md) | Array of assertions used for the test. | [optional] if omitted the server will use the default value of []
8+
**extracted_values** | [**[SyntheticsParsingOptions]**](SyntheticsParsingOptions.md) | Array of values to parse and save as variables from the response. | [optional]
9+
**name** | **str** | The name of the step. | [optional]
10+
**request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | [optional]
11+
**subtype** | [**SyntheticsAPIStepSubtype**](SyntheticsAPIStepSubtype.md) | | [optional]
12+
13+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
14+
15+

‎docs/v1/SyntheticsAPIStepSubtype.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SyntheticsAPIStepSubtype
2+
3+
The subtype of the Synthetic multistep API test step, currently only supporting `http`.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**value** | **str** | The subtype of the Synthetic multistep API test step, currently only supporting &#x60;http&#x60;. | defaults to "http", must be one of ["http", ]
8+
9+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
10+
11+

‎docs/v1/SyntheticsAPITestConfig.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ Configuration object for a Synthetic API test.
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | |
87
**assertions** | [**[SyntheticsAssertion]**](SyntheticsAssertion.md) | Array of assertions used for the test. | defaults to []
98
**config_variables** | [**[SyntheticsConfigVariable]**](SyntheticsConfigVariable.md) | Array of variables used for the test. | [optional]
9+
**request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | [optional]
10+
**steps** | [**[SyntheticsAPIStep]**](SyntheticsAPIStep.md) | When the test subtype is &#x60;multi&#x60;, the steps of the test. | [optional]
1011

1112
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
1213

‎docs/v1/SyntheticsApi.md

Lines changed: 92 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ with ApiClient(configuration) as api_client:
7272
name="MY_VARIABLE",
7373
parse_test_options=SyntheticsGlobalVariableParseTestOptions(
7474
field="content-type",
75-
parser=SyntheticsGlobalVariableParseTestOptionsParser(
75+
parser=SyntheticsVariableParser(
7676
type=SyntheticsGlobalVariableParserType("raw"),
7777
value="value_example",
7878
),
@@ -286,6 +286,51 @@ with ApiClient(configuration) as api_client:
286286
timeout=3.14,
287287
url="url_example",
288288
),
289+
steps=[
290+
SyntheticsAPIStep(
291+
assertions=[],
292+
extracted_values=[
293+
SyntheticsParsingOptions(
294+
field="content-type",
295+
name="name_example",
296+
parser=SyntheticsVariableParser(
297+
type=SyntheticsGlobalVariableParserType("raw"),
298+
value="value_example",
299+
),
300+
type=SyntheticsGlobalVariableParseTestOptionsType("http_body"),
301+
),
302+
],
303+
name="name_example",
304+
request=SyntheticsTestRequest(
305+
basic_auth=SyntheticsBasicAuth(
306+
password="",
307+
username="",
308+
),
309+
body="body_example",
310+
certificate=SyntheticsTestRequestCertificate(
311+
cert=SyntheticsTestRequestCertificateItem(
312+
content="content_example",
313+
filename="filename_example",
314+
updated_at="updated_at_example",
315+
),
316+
key=SyntheticsTestRequestCertificateItem(
317+
content="content_example",
318+
filename="filename_example",
319+
updated_at="updated_at_example",
320+
),
321+
),
322+
dns_server="dns_server_example",
323+
headers=SyntheticsTestHeaders(SyntheticsTestHeaders),
324+
host="host_example",
325+
method=HTTPMethod("GET"),
326+
port=1,
327+
query={},
328+
timeout=3.14,
329+
url="url_example",
330+
),
331+
subtype=SyntheticsAPIStepSubtype("http"),
332+
),
333+
],
289334
),
290335
locations=[
291336
"locations_example",
@@ -944,7 +989,7 @@ with ApiClient(configuration) as api_client:
944989
name="MY_VARIABLE",
945990
parse_test_options=SyntheticsGlobalVariableParseTestOptions(
946991
field="content-type",
947-
parser=SyntheticsGlobalVariableParseTestOptionsParser(
992+
parser=SyntheticsVariableParser(
948993
type=SyntheticsGlobalVariableParserType("raw"),
949994
value="value_example",
950995
),
@@ -1954,6 +1999,51 @@ with ApiClient(configuration) as api_client:
19541999
timeout=3.14,
19552000
url="url_example",
19562001
),
2002+
steps=[
2003+
SyntheticsAPIStep(
2004+
assertions=[],
2005+
extracted_values=[
2006+
SyntheticsParsingOptions(
2007+
field="content-type",
2008+
name="name_example",
2009+
parser=SyntheticsVariableParser(
2010+
type=SyntheticsGlobalVariableParserType("raw"),
2011+
value="value_example",
2012+
),
2013+
type=SyntheticsGlobalVariableParseTestOptionsType("http_body"),
2014+
),
2015+
],
2016+
name="name_example",
2017+
request=SyntheticsTestRequest(
2018+
basic_auth=SyntheticsBasicAuth(
2019+
password="",
2020+
username="",
2021+
),
2022+
body="body_example",
2023+
certificate=SyntheticsTestRequestCertificate(
2024+
cert=SyntheticsTestRequestCertificateItem(
2025+
content="content_example",
2026+
filename="filename_example",
2027+
updated_at="updated_at_example",
2028+
),
2029+
key=SyntheticsTestRequestCertificateItem(
2030+
content="content_example",
2031+
filename="filename_example",
2032+
updated_at="updated_at_example",
2033+
),
2034+
),
2035+
dns_server="dns_server_example",
2036+
headers=SyntheticsTestHeaders(SyntheticsTestHeaders),
2037+
host="host_example",
2038+
method=HTTPMethod("GET"),
2039+
port=1,
2040+
query={},
2041+
timeout=3.14,
2042+
url="url_example",
2043+
),
2044+
subtype=SyntheticsAPIStepSubtype("http"),
2045+
),
2046+
],
19572047
),
19582048
locations=[
19592049
"locations_example",

‎docs/v1/SyntheticsGlobalVariableParseTestOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Parser options to use for retrieving a Synthetics global variable from a Synthet
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**parser** | [**SyntheticsGlobalVariableParseTestOptionsParser**](SyntheticsGlobalVariableParseTestOptionsParser.md) | |
7+
**parser** | [**SyntheticsVariableParser**](SyntheticsVariableParser.md) | |
88
**type** | [**SyntheticsGlobalVariableParseTestOptionsType**](SyntheticsGlobalVariableParseTestOptionsType.md) | |
99
**field** | **str** | When type is &#x60;http_header&#x60;, name of the header to use to extract the value. | [optional]
1010

‎docs/v1/SyntheticsParsingOptions.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# SyntheticsParsingOptions
2+
3+
Parsing options for variables to extract.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**field** | **str** | When type is &#x60;http_header&#x60;, name of the header to use to extract the value. | [optional]
8+
**name** | **str** | Name of the variable to extract. | [optional]
9+
**parser** | [**SyntheticsVariableParser**](SyntheticsVariableParser.md) | | [optional]
10+
**type** | [**SyntheticsGlobalVariableParseTestOptionsType**](SyntheticsGlobalVariableParseTestOptionsType.md) | | [optional]
11+
12+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
13+
14+

‎docs/v1/SyntheticsTestDetailsSubType.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# SyntheticsTestDetailsSubType
22

3-
The sub-type of the Synthetic API test, `http`, `ssl`, `tcp` or `dns`.
3+
The subtype of the Synthetic API test, `http`, `ssl`, `tcp`, `dns` or `multi`.
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**value** | **str** | The sub-type of the Synthetic API test, &#x60;http&#x60;, &#x60;ssl&#x60;, &#x60;tcp&#x60; or &#x60;dns&#x60;. | must be one of ["http", "ssl", "tcp", "dns", ]
7+
**value** | **str** | The subtype of the Synthetic API test, &#x60;http&#x60;, &#x60;ssl&#x60;, &#x60;tcp&#x60;, &#x60;dns&#x60; or &#x60;multi&#x60;. | must be one of ["http", "ssl", "tcp", "dns", "multi", ]
88

99
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
1010

‎docs/v1/SyntheticsGlobalVariableParseTestOptionsParser.md renamed to ‎docs/v1/SyntheticsVariableParser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SyntheticsGlobalVariableParseTestOptionsParser
1+
# SyntheticsVariableParser
22

33
Details of the parser to use for the global variable.
44
## Properties

0 commit comments

Comments
 (0)