Skip to content

Commit 3d4e5ef

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit ac49e68 of spec repo (#98)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 2c11b0a commit 3d4e5ef

20 files changed

+179
-101
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.2.0",
7-
"regenerated": "2020-09-30 16:24:43.404702",
8-
"spec_repo_commit": "cc01f26"
7+
"regenerated": "2020-10-01 09:00:18.143854",
8+
"spec_repo_commit": "ac49e68"
99
},
1010
"v2": {
1111
"apigentools_version": "1.2.0",
12-
"regenerated": "2020-09-30 16:24:53.798609",
13-
"spec_repo_commit": "cc01f26"
12+
"regenerated": "2020-10-01 09:00:27.511464",
13+
"spec_repo_commit": "ac49e68"
1414
}
1515
}
1616
}

docs/v1/README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -667,12 +667,14 @@ Learn more in the [Browser test Actions documentation](https://docs.datadoghq.co
667667
- [SyntheticsCITest](Test configuration for Synthetics CI.md)
668668
- [SyntheticsCITestBody](Object describing the synthetics tests to trigger..md)
669669
- [SyntheticsCITestMetadata](Metadata for the Synthetics tests run.md)
670-
- [SyntheticsCITestMetadataCi](.md)
671-
- [SyntheticsCITestMetadataGit](.md)
670+
- [SyntheticsCITestMetadataCi](Describe CI provider..md)
671+
- [SyntheticsCITestMetadataGit](Git information..md)
672672
- [SyntheticsCheckType](Type of assertion to apply in an API test..md)
673-
- [SyntheticsDeleteTestsPayload](A JSON list of the ID or IDs of the Synthetic tests that you want to delete..md)
673+
- [SyntheticsDeleteTestsPayload](A JSON list of the ID or IDs of the Synthetic tests that you want
674+
to delete..md)
674675
- [SyntheticsDeleteTestsResponse](Response object for deleting Synthetic tests..md)
675-
- [SyntheticsDeleteTestsResponseDeletedTests](Object containing a deleted Synthetic test ID with the associated deletion timestamp..md)
676+
- [SyntheticsDeleteTestsResponseDeletedTests](Object containing a deleted Synthetic test ID with the associated
677+
deletion timestamp..md)
676678
- [SyntheticsDevice](Object describing the device used to perform the Synthetic test..md)
677679
- [SyntheticsDeviceID](The device ID..md)
678680
- [SyntheticsErrorCode](Error code that can be returned by a Synthetic test..md)
@@ -681,7 +683,8 @@ Learn more in the [Browser test Actions documentation](https://docs.datadoghq.co
681683
- [SyntheticsGlobalVariable](Synthetics global variable..md)
682684
- [SyntheticsGlobalVariableValue](Value of the global variable..md)
683685
- [SyntheticsListTestsResponse](Object containing an array of Synthetic tests configuration..md)
684-
- [SyntheticsLocation](Synthetics location that can be used when creating or editing a test..md)
686+
- [SyntheticsLocation](Synthetic location that can be used when creating or editing a
687+
test..md)
685688
- [SyntheticsLocations](List of Synthetics locations..md)
686689
- [SyntheticsPlayingTab](Navigate between different tabs for your browser test..md)
687690
- [SyntheticsResource](Object describing a resource which is the combination of requests (fetch, XHR) and Assets (HTML, CSS, JS, images)..md)
@@ -695,25 +698,28 @@ Learn more in the [Browser test Actions documentation](https://docs.datadoghq.co
695698
- [SyntheticsStepType](Step type used in your Synthetic test..md)
696699
- [SyntheticsTestConfig](Configuration object for a Synthetic test..md)
697700
- [SyntheticsTestDetails](Object containing details about your Synthetic test..md)
698-
- [SyntheticsTestDetailsSubType](The sub-type of the Synthetic API test, `http`, `ssl`, `tcp` or `dns`..md)
701+
- [SyntheticsTestDetailsSubType](The sub-type of the Synthetic API test, `http`, `ssl`, `tcp` or
702+
`dns`..md)
699703
- [SyntheticsTestDetailsType](Type of the Synthetic test, either `api` or `browser`..md)
700704
- [SyntheticsTestHeaders](Headers to include when performing the test..md)
701705
- [SyntheticsTestMonitorStatus](The status of your Synthetic monitor.
702706
* `O` for not triggered
703707
* `1` for triggered
704708
* `2` for no data.md)
705709
- [SyntheticsTestOptions](Object describing the extra options for a Synthetic test..md)
706-
- [SyntheticsTestOptionsMonitorOptions](Object containing the options for a Synthetic test as a monitor (e.g. renotification)..md)
710+
- [SyntheticsTestOptionsMonitorOptions](Object containing the options for a Synthetic test as a monitor
711+
(for example, renotification)..md)
707712
- [SyntheticsTestOptionsRetry](Object describing the retry strategy to apply to a Synthetic test..md)
708-
- [SyntheticsTestPauseStatus](Define whether you want to start (`live`) or pause (`paused`) a Synthetic test..md)
713+
- [SyntheticsTestPauseStatus](Define whether you want to start (`live`) or pause (`paused`) a
714+
Synthetic test..md)
709715
- [SyntheticsTestProcessStatus](Status of a Synthetic test..md)
710716
- [SyntheticsTestRequest](Object describing the Synthetic test request..md)
711717
- [SyntheticsTickInterval](The frequency at which to run the Synthetic test (in seconds)..md)
712718
- [SyntheticsTiming](Object containing all metrics and their values collected for a Synthetic API test.
713719
Learn more about those metrics in [Synthetics documentation](https://docs.datadoghq.com/synthetics/#metrics)..md)
714720
- [SyntheticsTriggerCITestsResponse](Object containing information about the tests triggered..md)
715721
- [SyntheticsTriggerCITestsResponseLocations](Synthetics location..md)
716-
- [SyntheticsTriggerCITestsResponseResults](.md)
722+
- [SyntheticsTriggerCITestsResponseResults](Information about a single test run..md)
717723
- [SyntheticsUpdateTestPauseStatusPayload](Object to start or pause an existing Synthetic test..md)
718724
- [SyntheticsWarningType](User locator used..md)
719725
- [TableWidgetDefinition](The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key..md)

docs/v1/SyntheticsApi.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,15 @@ with datadog_api_client.v1.ApiClient(configuration) as api_client:
6969
# Create an instance of the API class
7070
api_instance = synthetics_api.SyntheticsApi(api_client)
7171
body = SyntheticsGlobalVariable(
72-
description="description_example",
72+
description="Example description",
7373
id="id_example",
74-
name="name_example",
74+
name="MY_VARIABLE",
7575
tags=[
76-
"tags_example",
76+
"["team:front","test:workflow-1"]",
7777
],
7878
value=SyntheticsGlobalVariableValue(
7979
secure=True,
80-
value="value_example",
80+
value="example-value",
8181
),
8282
) # SyntheticsGlobalVariable | Details of the global variable to create.
8383

@@ -494,15 +494,15 @@ with datadog_api_client.v1.ApiClient(configuration) as api_client:
494494
api_instance = synthetics_api.SyntheticsApi(api_client)
495495
variable_id = "variable_id_example" # str | The ID of the global variable.
496496
body = SyntheticsGlobalVariable(
497-
description="description_example",
497+
description="Example description",
498498
id="id_example",
499-
name="name_example",
499+
name="MY_VARIABLE",
500500
tags=[
501-
"tags_example",
501+
"["team:front","test:workflow-1"]",
502502
],
503503
value=SyntheticsGlobalVariableValue(
504504
secure=True,
505-
value="value_example",
505+
value="example-value",
506506
),
507507
) # SyntheticsGlobalVariable | Details of the global variable to update.
508508

@@ -736,7 +736,7 @@ Name | Type | Description | Notes
736736
737737
Get a test configuration (browser)
738738

739-
Get the detailed configuration (including steps) associated with a Synthetics browser test.
739+
Get the detailed configuration (including steps) associated with a Synthetic browser test.
740740

741741
### Example
742742

@@ -1175,7 +1175,7 @@ Name | Type | Description | Notes
11751175
11761176
Get all locations (public and private)
11771177

1178-
Get the list of public and private locations available for Synthetics tests. No arguments required.
1178+
Get the list of public and private locations available for Synthetic tests. No arguments required.
11791179

11801180
### Example
11811181

@@ -1404,7 +1404,7 @@ with datadog_api_client.v1.ApiClient(configuration) as api_client:
14041404
commit_sha="commit_sha_example",
14051405
),
14061406
),
1407-
public_id="public_id_example",
1407+
public_id="aaa-aaa-aaa",
14081408
retry=SyntheticsTestOptionsRetry(
14091409
count=1,
14101410
interval=3.14,

docs/v1/SyntheticsCITestMetadataCi.md

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

3+
Describe CI provider.
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------
6-
**pipeline** | **str** | | [optional]
7-
**provider** | **str** | | [optional]
7+
**pipeline** | **str** | Name of the pipeline. | [optional]
8+
**provider** | **str** | Name of the CI provider. | [optional]
89

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

docs/v1/SyntheticsCITestMetadataGit.md

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

3+
Git information.
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------
6-
**branch** | **str** | | [optional]
7-
**commit_sha** | **str** | | [optional]
7+
**branch** | **str** | Branch name. | [optional]
8+
**commit_sha** | **str** | Commit SHA. | [optional]
89

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

docs/v1/SyntheticsLocation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SyntheticsLocation
22

3-
Synthetics location that can be used when creating or editing a test.
3+
Synthetic location that can be used when creating or editing a test.
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------

docs/v1/SyntheticsTestOptionsMonitorOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SyntheticsTestOptionsMonitorOptions
22

3-
Object containing the options for a Synthetic test as a monitor (e.g. renotification).
3+
Object containing the options for a Synthetic test as a monitor (for example, renotification).
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------

docs/v1/SyntheticsTriggerCITestsResponseResults.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# SyntheticsTriggerCITestsResponseResults
22

3+
Information about a single test run.
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

docs/v2/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,8 @@ This time is calculated from the first seen timestamp..md)
292292
- [SecurityMonitoringRuleSeverity](Severity of the Security Signal..md)
293293
- [SecurityMonitoringRuleUpdatePayload](Update an existing rule..md)
294294
- [SecurityMonitoringSignal](Object description of a security signal..md)
295-
- [SecurityMonitoringSignalAttributes](The JSON object containing all signal attributes and their associated values..md)
295+
- [SecurityMonitoringSignalAttributes](The object containing all signal attributes and their
296+
associated values..md)
296297
- [SecurityMonitoringSignalListRequest](The request for a security signal list..md)
297298
- [SecurityMonitoringSignalListRequestFilter](Search filters for listing security signals..md)
298299
- [SecurityMonitoringSignalListRequestPage](The paging attributes for listing security signals..md)

docs/v2/RolesApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ with datadog_api_client.v2.ApiClient(configuration) as api_client:
273273
attributes=RoleCreateAttributes(
274274
created_at=dateutil_parser('1970-01-01T00:00:00.00Z'),
275275
modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'),
276-
name="name_example",
276+
name="developers",
277277
),
278278
relationships=RoleRelationships(
279279
permissions=RelationshipToPermissions(
@@ -1115,7 +1115,7 @@ with datadog_api_client.v2.ApiClient(configuration) as api_client:
11151115
modified_at=dateutil_parser('1970-01-01T00:00:00.00Z'),
11161116
name="name_example",
11171117
),
1118-
id="id_example",
1118+
id="00000000-0000-0000-0000-000000000000",
11191119
type=RolesType("roles"),
11201120
),
11211121
) # RoleUpdateRequest | (optional)

0 commit comments

Comments
 (0)