Skip to content

Commit 87731bc

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 2cc8a06 of spec repo (#73)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent f349303 commit 87731bc

File tree

6 files changed

+24
-44
lines changed

6 files changed

+24
-44
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-16 15:43:42.759597",
8-
"spec_repo_commit": "cbef552"
7+
"regenerated": "2020-09-17 09:15:42.720492",
8+
"spec_repo_commit": "2cc8a06"
99
},
1010
"v2": {
1111
"apigentools_version": "1.2.0",
12-
"regenerated": "2020-09-16 15:43:53.567566",
13-
"spec_repo_commit": "cbef552"
12+
"regenerated": "2020-09-17 09:15:53.976903",
13+
"spec_repo_commit": "2cc8a06"
1414
}
1515
}
1616
}

docs/v1/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ Class | Method | HTTP request | Description
235235
*SyntheticsApi* | [**get_browser_test_result**](SyntheticsApi.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a test result (browser)
236236
*SyntheticsApi* | [**get_test**](SyntheticsApi.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration (API)
237237
*SyntheticsApi* | [**list_locations**](SyntheticsApi.md#list_locations) | **GET** /api/v1/synthetics/locations | Get all locations (public and private)
238-
*SyntheticsApi* | [**list_tests**](SyntheticsApi.md#list_tests) | **GET** /api/v1/synthetics/tests | Get a list of tests
238+
*SyntheticsApi* | [**list_tests**](SyntheticsApi.md#list_tests) | **GET** /api/v1/synthetics/tests | Get the list of all tests
239239
*SyntheticsApi* | [**trigger_ci_tests**](SyntheticsApi.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger some Synthetics tests for CI
240240
*SyntheticsApi* | [**update_test**](SyntheticsApi.md#update_test) | **PUT** /api/v1/synthetics/tests/{public_id} | Edit a test
241241
*SyntheticsApi* | [**update_test_pause_status**](SyntheticsApi.md#update_test_pause_status) | **PUT** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test

docs/v1/SyntheticsApi.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Method | HTTP request | Description
1616
[**get_browser_test_result**](SyntheticsApi.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a test result (browser)
1717
[**get_test**](SyntheticsApi.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration (API)
1818
[**list_locations**](SyntheticsApi.md#list_locations) | **GET** /api/v1/synthetics/locations | Get all locations (public and private)
19-
[**list_tests**](SyntheticsApi.md#list_tests) | **GET** /api/v1/synthetics/tests | Get a list of tests
19+
[**list_tests**](SyntheticsApi.md#list_tests) | **GET** /api/v1/synthetics/tests | Get the list of all tests
2020
[**trigger_ci_tests**](SyntheticsApi.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger some Synthetics tests for CI
2121
[**update_test**](SyntheticsApi.md#update_test) | **PUT** /api/v1/synthetics/tests/{public_id} | Edit a test
2222
[**update_test_pause_status**](SyntheticsApi.md#update_test_pause_status) | **PUT** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test
@@ -1261,9 +1261,9 @@ This endpoint does not need any parameter.
12611261
# **list_tests**
12621262
> SyntheticsListTestsResponse list_tests()
12631263
1264-
Get a list of tests
1264+
Get the list of all tests
12651265

1266-
Get the list of all Synthetic tests (can be filtered by type).
1266+
Get the list of all Synthetic tests.
12671267

12681268
### Example
12691269

@@ -1311,23 +1311,18 @@ configuration = datadog_api_client.v1.Configuration(
13111311
with datadog_api_client.v1.ApiClient(configuration) as api_client:
13121312
# Create an instance of the API class
13131313
api_instance = synthetics_api.SyntheticsApi(api_client)
1314-
check_type = "check_type_example" # str | API or browser to filter the list by test type, undefined to get the unfiltered list. (optional)
13151314

1316-
# example passing only required values which don't have defaults set
1317-
# and optional values
1315+
# example, this endpoint has no required or optional parameters
13181316
try:
1319-
# Get a list of tests
1320-
api_response = api_instance.list_tests(check_type=check_type)
1317+
# Get the list of all tests
1318+
api_response = api_instance.list_tests()
13211319
pprint(api_response)
13221320
except datadog_api_client.v1.ApiException as e:
13231321
print("Exception when calling SyntheticsApi->list_tests: %s\n" % e)
13241322
```
13251323

13261324
### Parameters
1327-
1328-
Name | Type | Description | Notes
1329-
------------- | ------------- | ------------- | -------------
1330-
**check_type** | **str**| API or browser to filter the list by test type, undefined to get the unfiltered list. | [optional]
1325+
This endpoint does not need any parameter.
13311326

13321327
### Return type
13331328

@@ -1345,7 +1340,7 @@ Name | Type | Description | Notes
13451340
### HTTP response details
13461341
| Status code | Description | Response headers |
13471342
|-------------|-------------|------------------|
1348-
**200** | OK - Returns the list of all Synthetic tests (properly filtered by type). | - |
1343+
**200** | OK - Returns the list of all Synthetic tests. | - |
13491344
**403** | Forbidden | - |
13501345
**404** | Synthetics is not activated for the user. | - |
13511346

src/datadog_api_client/v1/api/synthetics_api.py

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1550,9 +1550,9 @@ def __list_tests(
15501550
self,
15511551
**kwargs
15521552
):
1553-
"""Get a list of tests # noqa: E501
1553+
"""Get the list of all tests # noqa: E501
15541554
1555-
Get the list of all Synthetic tests (can be filtered by type). # noqa: E501
1555+
Get the list of all Synthetic tests. # noqa: E501
15561556
This method makes a synchronous HTTP request by default. To make an
15571557
asynchronous HTTP request, please pass async_req=True
15581558
@@ -1561,7 +1561,6 @@ def __list_tests(
15611561
15621562
15631563
Keyword Args:
1564-
check_type (str): API or browser to filter the list by test type, undefined to get the unfiltered list.. [optional]
15651564
_return_http_data_only (bool): response data without head status
15661565
code and headers. Default is True.
15671566
_preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1622,7 +1621,6 @@ def __list_tests(
16221621
},
16231622
params_map={
16241623
'all': [
1625-
'check_type',
16261624
],
16271625
'required': [],
16281626
'nullable': [
@@ -1638,14 +1636,10 @@ def __list_tests(
16381636
'allowed_values': {
16391637
},
16401638
'openapi_types': {
1641-
'check_type':
1642-
(str,),
16431639
},
16441640
'attribute_map': {
1645-
'check_type': 'check_type',
16461641
},
16471642
'location_map': {
1648-
'check_type': 'query',
16491643
},
16501644
'collection_format_map': {
16511645
}

src/datadog_api_client/v1/openapi.yaml

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13229,24 +13229,15 @@ paths:
1322913229
- Synthetics
1323013230
/api/v1/synthetics/tests:
1323113231
get:
13232-
description: Get the list of all Synthetic tests (can be filtered by type).
13232+
description: Get the list of all Synthetic tests.
1323313233
operationId: ListTests
13234-
parameters:
13235-
- description: API or browser to filter the list by test type, undefined to
13236-
get the unfiltered list.
13237-
in: query
13238-
name: check_type
13239-
required: false
13240-
schema:
13241-
type: string
1324213234
responses:
1324313235
'200':
1324413236
content:
1324513237
application/json:
1324613238
schema:
1324713239
$ref: '#/components/schemas/SyntheticsListTestsResponse'
13248-
description: OK - Returns the list of all Synthetic tests (properly filtered
13249-
by type).
13240+
description: OK - Returns the list of all Synthetic tests.
1325013241
'403':
1325113242
content:
1325213243
application/json:
@@ -13259,7 +13250,7 @@ paths:
1325913250
schema:
1326013251
$ref: '#/components/schemas/APIErrorResponse'
1326113252
description: Synthetics is not activated for the user.
13262-
summary: Get a list of tests
13253+
summary: Get the list of all tests
1326313254
tags:
1326413255
- Synthetics
1326513256
post:

tests/v1/features/synthetics.feature

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,6 @@ Feature: Synthetics
2121
When the request is sent
2222
Then the response status is 200 OK
2323

24-
@generated @skip
25-
Scenario: Get a list of tests returns "OK - Returns the list of all Synthetic tests (properly filtered by type)." response
26-
Given new "ListTests" request
27-
When the request is sent
28-
Then the response status is 200 OK - Returns the list of all Synthetic tests (properly filtered by type).
29-
3024
@generated @skip
3125
Scenario: Create a test returns "OK - Returns the created test details." response
3226
Given new "CreateTest" request
@@ -129,3 +123,9 @@ Feature: Synthetics
129123
And body {}
130124
When the request is sent
131125
Then the response status is 200 OK
126+
127+
@generated @skip
128+
Scenario: Get the list of all tests returns "OK - Returns the list of all Synthetic tests." response
129+
Given new "ListTests" request
130+
When the request is sent
131+
Then the response status is 200 OK - Returns the list of all Synthetic tests.

0 commit comments

Comments
 (0)