Skip to content

Clarify required fields for SyntheticsAPIStep, SyntheticsAPITest, and SyntheticsBrowserTest #1202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jan 18, 2022
Merged

Clarify required fields for SyntheticsAPIStep, SyntheticsAPITest, and SyntheticsBrowserTest #1202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7eb862e
[Synthetics] Update tests
romainberger Oct 6, 2021
9b94953
[Synthetics] Update tests
romainberger Oct 6, 2021
49a28ae
Merge master into datadog-api-spec/test/rberger/SYA-1153/synthetics-r…
api-clients-generation-pipeline[bot] Nov 11, 2021
bd13e07
Merge master into datadog-api-spec/test/rberger/SYA-1153/synthetics-r…
api-clients-generation-pipeline[bot] Nov 16, 2021
b802f97
Merge master into datadog-api-spec/test/rberger/SYA-1153/synthetics-r…
api-clients-generation-pipeline[bot] Nov 16, 2021
bd9d559
Merge master into datadog-api-spec/test/rberger/SYA-1153/synthetics-r…
api-clients-generation-pipeline[bot] Nov 25, 2021
5de12e2
Merge remote-tracking branch 'origin/master' into datadog-api-spec/te…
jirikuncar Jan 13, 2022
f708f3d
Merge master into datadog-api-spec/test/rberger/SYA-1153/synthetics-r…
api-clients-generation-pipeline[bot] Jan 17, 2022
5a895de
fix required fields
jirikuncar Jan 18, 2022
8ab8ffb
add type
jirikuncar Jan 18, 2022
a98b514
Merge master into datadog-api-spec/test/rberger/SYA-1153/synthetics-r…
api-clients-generation-pipeline[bot] Jan 18, 2022
a53511d
Regenerate client from commit 5808ab7 of spec repo
Jan 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.1",
"regenerated": "2022-01-18 11:14:16.772290",
"spec_repo_commit": "1d04508"
"regenerated": "2022-01-18 11:51:52.667238",
"spec_repo_commit": "5808ab7"
},
"v2": {
"apigentools_version": "1.6.1",
"regenerated": "2022-01-18 11:14:16.785877",
"spec_repo_commit": "1d04508"
"regenerated": "2022-01-18 11:51:52.680636",
"spec_repo_commit": "5808ab7"
}
}
}
28 changes: 26 additions & 2 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9759,6 +9759,10 @@ components:
assertions:
default: []
description: Array of assertions used for the test.
example:
- operator: lessThan
target: 1000
type: responseTime
items:
$ref: '#/components/schemas/SyntheticsAssertion'
type: array
Expand All @@ -9775,19 +9779,26 @@ components:
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
type: object
SyntheticsAPIStepSubtype:
description: The subtype of the Synthetic multistep API test step, currently
only supporting `http`.
enum:
- http
example: http
type: string
x-enum-varnames:
- HTTP
Expand Down Expand Up @@ -9816,7 +9827,7 @@ components:
type: integer
name:
description: Name of the test.
example: Test name
example: Example test name
type: string
options:
$ref: '#/components/schemas/SyntheticsTestOptions'
Expand All @@ -9839,6 +9850,12 @@ components:
type: array
type:
$ref: '#/components/schemas/SyntheticsAPITestType'
required:
- name
- config
- locations
- options
- type
type: object
SyntheticsAPITestConfig:
description: Configuration object for a Synthetic API test.
Expand Down Expand Up @@ -10314,6 +10331,8 @@ components:
$ref: '#/components/schemas/SyntheticsBrowserTestConfig'
locations:
description: Array of locations used to run the test.
example:
- example-location
items:
description: A location from which the test was run.
type: string
Expand All @@ -10330,6 +10349,7 @@ components:
type: integer
name:
description: Name of the test.
example: Example test name
type: string
options:
$ref: '#/components/schemas/SyntheticsTestOptions'
Expand All @@ -10353,7 +10373,11 @@ components:
type:
$ref: '#/components/schemas/SyntheticsBrowserTestType'
required:
- message
- config
- locations
- name
- options
- type
type: object
SyntheticsBrowserTestConfig:
description: Configuration object for a Synthetic browser test.
Expand Down
46 changes: 11 additions & 35 deletions api/v1/datadog/docs/SyntheticsAPIStep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

## Properties

| Name | Type | Description | Notes |
| ------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
| **AllowFailure** | Pointer to **bool** | Determines whether or not to continue with test if this step fails. | [optional] |
| **Assertions** | Pointer to [**[]SyntheticsAssertion**](SyntheticsAssertion.md) | Array of assertions used for the test. | [optional] [default to []] |
| **ExtractedValues** | Pointer to [**[]SyntheticsParsingOptions**](SyntheticsParsingOptions.md) | Array of values to parse and save as variables from the response. | [optional] |
| **IsCritical** | Pointer to **bool** | Determines whether or not to consider the entire test as failed if this step fails. Can be used only if `allowFailure` is `true`. | [optional] |
| **Name** | Pointer to **string** | The name of the step. | [optional] |
| **Request** | Pointer to [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | [optional] |
| **Retry** | Pointer to [**SyntheticsTestOptionsRetry**](SyntheticsTestOptionsRetry.md) | | [optional] |
| **Subtype** | Pointer to [**SyntheticsAPIStepSubtype**](SyntheticsAPIStepSubtype.md) | | [optional] |
| Name | Type | Description | Notes |
| ------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |
| **AllowFailure** | Pointer to **bool** | Determines whether or not to continue with test if this step fails. | [optional] |
| **Assertions** | [**[]SyntheticsAssertion**](SyntheticsAssertion.md) | Array of assertions used for the test. | [default to []] |
| **ExtractedValues** | Pointer to [**[]SyntheticsParsingOptions**](SyntheticsParsingOptions.md) | Array of values to parse and save as variables from the response. | [optional] |
| **IsCritical** | Pointer to **bool** | Determines whether or not to consider the entire test as failed if this step fails. Can be used only if `allowFailure` is `true`. | [optional] |
| **Name** | **string** | The name of the step. |
| **Request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | |
| **Retry** | Pointer to [**SyntheticsTestOptionsRetry**](SyntheticsTestOptionsRetry.md) | | [optional] |
| **Subtype** | [**SyntheticsAPIStepSubtype**](SyntheticsAPIStepSubtype.md) | |

## Methods

### NewSyntheticsAPIStep

`func NewSyntheticsAPIStep() *SyntheticsAPIStep`
`func NewSyntheticsAPIStep(assertions []SyntheticsAssertion, name string, request SyntheticsTestRequest, subtype SyntheticsAPIStepSubtype) *SyntheticsAPIStep`

NewSyntheticsAPIStep instantiates a new SyntheticsAPIStep object.
This constructor will assign default values to properties that have it defined,
Expand Down Expand Up @@ -76,12 +76,6 @@ and a boolean to check if the value has been set.

SetAssertions sets Assertions field to given value.

### HasAssertions

`func (o *SyntheticsAPIStep) HasAssertions() bool`

HasAssertions returns a boolean if a field has been set.

### GetExtractedValues

`func (o *SyntheticsAPIStep) GetExtractedValues() []SyntheticsParsingOptions`
Expand Down Expand Up @@ -151,12 +145,6 @@ and a boolean to check if the value has been set.

SetName sets Name field to given value.

### HasName

`func (o *SyntheticsAPIStep) HasName() bool`

HasName returns a boolean if a field has been set.

### GetRequest

`func (o *SyntheticsAPIStep) GetRequest() SyntheticsTestRequest`
Expand All @@ -176,12 +164,6 @@ and a boolean to check if the value has been set.

SetRequest sets Request field to given value.

### HasRequest

`func (o *SyntheticsAPIStep) HasRequest() bool`

HasRequest returns a boolean if a field has been set.

### GetRetry

`func (o *SyntheticsAPIStep) GetRetry() SyntheticsTestOptionsRetry`
Expand Down Expand Up @@ -226,10 +208,4 @@ and a boolean to check if the value has been set.

SetSubtype sets Subtype field to given value.

### HasSubtype

`func (o *SyntheticsAPIStep) HasSubtype() bool`

HasSubtype returns a boolean if a field has been set.

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
58 changes: 14 additions & 44 deletions api/v1/datadog/docs/SyntheticsAPITest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@

## Properties

| Name | Type | Description | Notes |
| ------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- | ------------------------------------------------- |
| **Config** | Pointer to [**SyntheticsAPITestConfig**](SyntheticsAPITestConfig.md) | | [optional] |
| **Locations** | Pointer to **[]string** | Array of locations used to run the test. | [optional] |
| **Message** | Pointer to **string** | Notification message associated with the test. | [optional] |
| **MonitorId** | Pointer to **int64** | The associated monitor ID. | [optional] [readonly] |
| **Name** | Pointer to **string** | Name of the test. | [optional] |
| **Options** | Pointer to [**SyntheticsTestOptions**](SyntheticsTestOptions.md) | | [optional] |
| **PublicId** | Pointer to **string** | The public ID for the test. | [optional] [readonly] |
| **Status** | Pointer to [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] |
| **Subtype** | Pointer to [**SyntheticsTestDetailsSubType**](SyntheticsTestDetailsSubType.md) | | [optional] |
| **Tags** | Pointer to **[]string** | Array of tags attached to the test. | [optional] |
| **Type** | Pointer to [**SyntheticsAPITestType**](SyntheticsAPITestType.md) | | [optional] [default to SYNTHETICSAPITESTTYPE_API] |
| Name | Type | Description | Notes |
| ------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- | -------------------------------------- |
| **Config** | [**SyntheticsAPITestConfig**](SyntheticsAPITestConfig.md) | |
| **Locations** | **[]string** | Array of locations used to run the test. |
| **Message** | Pointer to **string** | Notification message associated with the test. | [optional] |
| **MonitorId** | Pointer to **int64** | The associated monitor ID. | [optional] [readonly] |
| **Name** | **string** | Name of the test. |
| **Options** | [**SyntheticsTestOptions**](SyntheticsTestOptions.md) | |
| **PublicId** | Pointer to **string** | The public ID for the test. | [optional] [readonly] |
| **Status** | Pointer to [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] |
| **Subtype** | Pointer to [**SyntheticsTestDetailsSubType**](SyntheticsTestDetailsSubType.md) | | [optional] |
| **Tags** | Pointer to **[]string** | Array of tags attached to the test. | [optional] |
| **Type** | [**SyntheticsAPITestType**](SyntheticsAPITestType.md) | | [default to SYNTHETICSAPITESTTYPE_API] |

## Methods

### NewSyntheticsAPITest

`func NewSyntheticsAPITest() *SyntheticsAPITest`
`func NewSyntheticsAPITest(config SyntheticsAPITestConfig, locations []string, name string, options SyntheticsTestOptions, type_ SyntheticsAPITestType) *SyntheticsAPITest`

NewSyntheticsAPITest instantiates a new SyntheticsAPITest object.
This constructor will assign default values to properties that have it defined,
Expand Down Expand Up @@ -54,12 +54,6 @@ and a boolean to check if the value has been set.

SetConfig sets Config field to given value.

### HasConfig

`func (o *SyntheticsAPITest) HasConfig() bool`

HasConfig returns a boolean if a field has been set.

### GetLocations

`func (o *SyntheticsAPITest) GetLocations() []string`
Expand All @@ -79,12 +73,6 @@ and a boolean to check if the value has been set.

SetLocations sets Locations field to given value.

### HasLocations

`func (o *SyntheticsAPITest) HasLocations() bool`

HasLocations returns a boolean if a field has been set.

### GetMessage

`func (o *SyntheticsAPITest) GetMessage() string`
Expand Down Expand Up @@ -154,12 +142,6 @@ and a boolean to check if the value has been set.

SetName sets Name field to given value.

### HasName

`func (o *SyntheticsAPITest) HasName() bool`

HasName returns a boolean if a field has been set.

### GetOptions

`func (o *SyntheticsAPITest) GetOptions() SyntheticsTestOptions`
Expand All @@ -179,12 +161,6 @@ and a boolean to check if the value has been set.

SetOptions sets Options field to given value.

### HasOptions

`func (o *SyntheticsAPITest) HasOptions() bool`

HasOptions returns a boolean if a field has been set.

### GetPublicId

`func (o *SyntheticsAPITest) GetPublicId() string`
Expand Down Expand Up @@ -304,10 +280,4 @@ and a boolean to check if the value has been set.

SetType sets Type field to given value.

### HasType

`func (o *SyntheticsAPITest) HasType() bool`

HasType returns a boolean if a field has been set.

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