Add support for multistep tests in Synthetics

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.4.1.dev8",
-            "regenerated": "2021-03-08 11:23:25.061959",
-            "spec_repo_commit": "a75da1e"
+            "regenerated": "2021-03-08 16:50:06.973164",
+            "spec_repo_commit": "ce24aad"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev8",
-            "regenerated": "2021-03-08 11:23:38.208550",
-            "spec_repo_commit": "a75da1e"
+            "regenerated": "2021-03-08 16:50:20.581412",
+            "spec_repo_commit": "ce24aad"
         }
     }
 }

data/v1/openapi.yaml

@@ -6295,6 +6295,37 @@ components:
       items:
         $ref: '#/components/schemas/SlackIntegrationChannel'
       type: array
+    SyntheticsAPIStep:
+      description: The steps used in a Synthetics multistep API test.
+      properties:
+        assertions:
+          default: []
+          description: Array of assertions used for the test.
+          example: []
+          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
+        name:
+          description: The name of the step.
+          type: string
+        request:
+          $ref: '#/components/schemas/SyntheticsTestRequest'
+        subtype:
+          $ref: '#/components/schemas/SyntheticsAPIStepSubtype'
+      type: object
+    SyntheticsAPIStepSubtype:
+      description: The subtype of the Synthetic multistep API test step, currently
+        only supporting `http`.
+      enum:
+      - http
+      type: string
+      x-enum-varnames:
+      - HTTP
     SyntheticsAPITest:
       description: Object containing details about a Synthetic API test.
       properties:
@@ -6351,8 +6382,12 @@ components:
           type: array
         request:
           $ref: '#/components/schemas/SyntheticsTestRequest'
+        steps:
+          description: When the test subtype is `multi`, the steps of the test.
+          items:
+            $ref: '#/components/schemas/SyntheticsAPIStep'
+          type: array
       required:
-      - request
       - assertions
       type: object
     SyntheticsAPITestResultData:
@@ -7153,20 +7188,7 @@ components:
               example: content-type
               type: string
             parser:
-              description: Details of the parser to use for the global variable.
-              example:
-                type: regex
-                value: .*
-              properties:
-                type:
-                  $ref: '#/components/schemas/SyntheticsGlobalVariableParserType'
-                value:
-                  description: Regex or JSON path used for the parser. Not used with
-                    type `raw`.
-                  type: string
-              required:
-              - type
-              type: object
+              $ref: '#/components/schemas/SyntheticsVariableParser'
             type:
               $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType'
           required:
@@ -7264,6 +7286,22 @@ components:
             $ref: '#/components/schemas/SyntheticsLocation'
           type: array
       type: object
+    SyntheticsParsingOptions:
+      description: Parsing options for variables to extract.
+      properties:
+        field:
+          description: When type is `http_header`, name of the header to use to extract
+            the value.
+          example: content-type
+          type: string
+        name:
+          description: Name of the variable to extract.
+          type: string
+        parser:
+          $ref: '#/components/schemas/SyntheticsVariableParser'
+        type:
+          $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType'
+      type: object
     SyntheticsPlayingTab:
       description: Navigate between different tabs for your browser test.
       enum:
@@ -7666,20 +7704,22 @@ components:
           $ref: '#/components/schemas/SyntheticsTestDetailsType'
       type: object
     SyntheticsTestDetailsSubType:
-      description: 'The sub-type of the Synthetic API test, `http`, `ssl`, `tcp` or
+      description: 'The subtype of the Synthetic API test, `http`, `ssl`, `tcp`,
 
-        `dns`.'
+        `dns` or `multi`.'
       enum:
       - http
       - ssl
       - tcp
       - dns
+      - multi
       type: string
       x-enum-varnames:
       - HTTP
       - SSL
       - TCP
       - DNS
+      - MULTI
     SyntheticsTestDetailsType:
       description: Type of the Synthetic test, either `api` or `browser`.
       enum:
@@ -7984,6 +8024,21 @@ components:
         new_status:
           $ref: '#/components/schemas/SyntheticsTestPauseStatus'
       type: object
+    SyntheticsVariableParser:
+      description: Details of the parser to use for the global variable.
+      example:
+        type: regex
+        value: .*
+      properties:
+        type:
+          $ref: '#/components/schemas/SyntheticsGlobalVariableParserType'
+        value:
+          description: Regex or JSON path used for the parser. Not used with type
+            `raw`.
+          type: string
+      required:
+      - type
+      type: object
     SyntheticsWarningType:
       description: User locator used.
       enum:

docs/v1/README.md

@@ -538,6 +538,8 @@ Class | Method | HTTP request | Description
  - [DatadogAPIClient::V1::ServiceSummaryWidgetDefinitionType](ServiceSummaryWidgetDefinitionType.md)
  - [DatadogAPIClient::V1::SlackIntegrationChannel](SlackIntegrationChannel.md)
  - [DatadogAPIClient::V1::SlackIntegrationChannelDisplay](SlackIntegrationChannelDisplay.md)
+ - [DatadogAPIClient::V1::SyntheticsAPIStep](SyntheticsAPIStep.md)
+ - [DatadogAPIClient::V1::SyntheticsAPIStepSubtype](SyntheticsAPIStepSubtype.md)
  - [DatadogAPIClient::V1::SyntheticsAPITest](SyntheticsAPITest.md)
  - [DatadogAPIClient::V1::SyntheticsAPITestConfig](SyntheticsAPITestConfig.md)
  - [DatadogAPIClient::V1::SyntheticsAPITestResultData](SyntheticsAPITestResultData.md)
@@ -585,13 +587,13 @@ Class | Method | HTTP request | Description
  - [DatadogAPIClient::V1::SyntheticsGetBrowserTestLatestResultsResponse](SyntheticsGetBrowserTestLatestResultsResponse.md)
  - [DatadogAPIClient::V1::SyntheticsGlobalVariable](SyntheticsGlobalVariable.md)
  - [DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptions](SyntheticsGlobalVariableParseTestOptions.md)
- - [DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptionsParser](SyntheticsGlobalVariableParseTestOptionsParser.md)
  - [DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptionsType](SyntheticsGlobalVariableParseTestOptionsType.md)
  - [DatadogAPIClient::V1::SyntheticsGlobalVariableParserType](SyntheticsGlobalVariableParserType.md)
  - [DatadogAPIClient::V1::SyntheticsGlobalVariableValue](SyntheticsGlobalVariableValue.md)
  - [DatadogAPIClient::V1::SyntheticsListTestsResponse](SyntheticsListTestsResponse.md)
  - [DatadogAPIClient::V1::SyntheticsLocation](SyntheticsLocation.md)
  - [DatadogAPIClient::V1::SyntheticsLocations](SyntheticsLocations.md)
+ - [DatadogAPIClient::V1::SyntheticsParsingOptions](SyntheticsParsingOptions.md)
  - [DatadogAPIClient::V1::SyntheticsPlayingTab](SyntheticsPlayingTab.md)
  - [DatadogAPIClient::V1::SyntheticsPrivateLocation](SyntheticsPrivateLocation.md)
  - [DatadogAPIClient::V1::SyntheticsPrivateLocationCreationResponse](SyntheticsPrivateLocationCreationResponse.md)
@@ -625,6 +627,7 @@ Class | Method | HTTP request | Description
  - [DatadogAPIClient::V1::SyntheticsTriggerCITestRunResult](SyntheticsTriggerCITestRunResult.md)
  - [DatadogAPIClient::V1::SyntheticsTriggerCITestsResponse](SyntheticsTriggerCITestsResponse.md)
  - [DatadogAPIClient::V1::SyntheticsUpdateTestPauseStatusPayload](SyntheticsUpdateTestPauseStatusPayload.md)
+ - [DatadogAPIClient::V1::SyntheticsVariableParser](SyntheticsVariableParser.md)
  - [DatadogAPIClient::V1::SyntheticsWarningType](SyntheticsWarningType.md)
  - [DatadogAPIClient::V1::TableWidgetCellDisplayMode](TableWidgetCellDisplayMode.md)
  - [DatadogAPIClient::V1::TableWidgetDefinition](TableWidgetDefinition.md)

docs/v1/SyntheticsAPIStep.md

@@ -0,0 +1,26 @@
+# DatadogAPIClient::V1::SyntheticsAPIStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. | [optional] |
+| **extracted_values** | [**Array<SyntheticsParsingOptions>**](SyntheticsParsingOptions.md) | Array of values to parse and save as variables from the response. | [optional] |
+| **name** | **String** | The name of the step. | [optional] |
+| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) |  | [optional] |
+| **subtype** | [**SyntheticsAPIStepSubtype**](SyntheticsAPIStepSubtype.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'datadog_api_client/v1'
+
+instance = DatadogAPIClient::V1::SyntheticsAPIStep.new(
+  assertions: [],
+  extracted_values: null,
+  name: null,
+  request: null,
+  subtype: null
+)
+```
+

docs/v1/SyntheticsAPIStepSubtype.md

@@ -0,0 +1,15 @@
+# DatadogAPIClient::V1::SyntheticsAPIStepSubtype
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'datadog_api_client/v1'
+
+instance = DatadogAPIClient::V1::SyntheticsAPIStepSubtype.new()
+```
+

docs/v1/SyntheticsAPITestConfig.md

@@ -6,7 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. |  |
 | **config_variables** | [**Array<SyntheticsConfigVariable>**](SyntheticsConfigVariable.md) | Array of variables used for the test. | [optional] |
-| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) |  |  |
+| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) |  | [optional] |
+| **steps** | [**Array<SyntheticsAPIStep>**](SyntheticsAPIStep.md) | When the test subtype is `multi`, the steps of the test. | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'datadog_api_client/v1'
 instance = DatadogAPIClient::V1::SyntheticsAPITestConfig.new(
   assertions: [],
   config_variables: null,
-  request: null
+  request: null,
+  steps: null
 )
 ```
 

docs/v1/SyntheticsGlobalVariableParseTestOptions.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **field** | **String** | When type is `http_header`, name of the header to use to extract the value. | [optional] |
-| **parser** | [**SyntheticsGlobalVariableParseTestOptionsParser**](SyntheticsGlobalVariableParseTestOptionsParser.md) |  |  |
+| **parser** | [**SyntheticsVariableParser**](SyntheticsVariableParser.md) |  |  |
 | **type** | [**SyntheticsGlobalVariableParseTestOptionsType**](SyntheticsGlobalVariableParseTestOptionsType.md) |  |  |
 
 ## Example

docs/v1/SyntheticsParsingOptions.md

@@ -0,0 +1,24 @@
+# DatadogAPIClient::V1::SyntheticsParsingOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field** | **String** | When type is `http_header`, name of the header to use to extract the value. | [optional] |
+| **name** | **String** | Name of the variable to extract. | [optional] |
+| **parser** | [**SyntheticsVariableParser**](SyntheticsVariableParser.md) |  | [optional] |
+| **type** | [**SyntheticsGlobalVariableParseTestOptionsType**](SyntheticsGlobalVariableParseTestOptionsType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'datadog_api_client/v1'
+
+instance = DatadogAPIClient::V1::SyntheticsParsingOptions.new(
+  field: content-type,
+  name: null,
+  parser: null,
+  type: null
+)
+```
+

docs/v1/SyntheticsGlobalVariableParseTestOptionsParser.md → docs/v1/SyntheticsVariableParser.md

@@ -1,4 +1,4 @@
-# DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptionsParser
+# DatadogAPIClient::V1::SyntheticsVariableParser
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'datadog_api_client/v1'
 
-instance = DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptionsParser.new(
+instance = DatadogAPIClient::V1::SyntheticsVariableParser.new(
   type: null,
   value: null
 )

lib/datadog_api_client/v1.rb

@@ -292,6 +292,8 @@
 require 'datadog_api_client/v1/models/service_summary_widget_definition_type'
 require 'datadog_api_client/v1/models/slack_integration_channel'
 require 'datadog_api_client/v1/models/slack_integration_channel_display'
+require 'datadog_api_client/v1/models/synthetics_api_step'
+require 'datadog_api_client/v1/models/synthetics_api_step_subtype'
 require 'datadog_api_client/v1/models/synthetics_api_test'
 require 'datadog_api_client/v1/models/synthetics_api_test_config'
 require 'datadog_api_client/v1/models/synthetics_api_test_result_data'
@@ -339,13 +341,13 @@
 require 'datadog_api_client/v1/models/synthetics_get_browser_test_latest_results_response'
 require 'datadog_api_client/v1/models/synthetics_global_variable'
 require 'datadog_api_client/v1/models/synthetics_global_variable_parse_test_options'
-require 'datadog_api_client/v1/models/synthetics_global_variable_parse_test_options_parser'
 require 'datadog_api_client/v1/models/synthetics_global_variable_parse_test_options_type'
 require 'datadog_api_client/v1/models/synthetics_global_variable_parser_type'
 require 'datadog_api_client/v1/models/synthetics_global_variable_value'
 require 'datadog_api_client/v1/models/synthetics_list_tests_response'
 require 'datadog_api_client/v1/models/synthetics_location'
 require 'datadog_api_client/v1/models/synthetics_locations'
+require 'datadog_api_client/v1/models/synthetics_parsing_options'
 require 'datadog_api_client/v1/models/synthetics_playing_tab'
 require 'datadog_api_client/v1/models/synthetics_private_location'
 require 'datadog_api_client/v1/models/synthetics_private_location_creation_response'
@@ -379,6 +381,7 @@
 require 'datadog_api_client/v1/models/synthetics_trigger_ci_test_run_result'
 require 'datadog_api_client/v1/models/synthetics_trigger_ci_tests_response'
 require 'datadog_api_client/v1/models/synthetics_update_test_pause_status_payload'
+require 'datadog_api_client/v1/models/synthetics_variable_parser'
 require 'datadog_api_client/v1/models/synthetics_warning_type'
 require 'datadog_api_client/v1/models/table_widget_cell_display_mode'
 require 'datadog_api_client/v1/models/table_widget_definition'