Skip to content

Commit 9a09e39

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
Regenerate client from commit 6dc3341 of spec repo (#250)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 9b120e6 commit 9a09e39

File tree

11 files changed

+48
-45
lines changed

11 files changed

+48
-45
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.dev2",
7-
"regenerated": "2021-01-28 17:53:54.712855",
8-
"spec_repo_commit": "f21827d"
7+
"regenerated": "2021-01-29 07:52:53.496255",
8+
"spec_repo_commit": "6dc3341"
99
},
1010
"v2": {
1111
"apigentools_version": "1.4.1.dev2",
12-
"regenerated": "2021-01-28 17:54:06.073746",
13-
"spec_repo_commit": "f21827d"
12+
"regenerated": "2021-01-29 07:53:05.627056",
13+
"spec_repo_commit": "6dc3341"
1414
}
1515
}
1616
}

docs/v1/LogsApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.datadoghq.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**list_logs**](LogsApi.md#list_logs) | **POST** /api/v1/logs-queries/list | Get a list of logs
7+
[**list_logs**](LogsApi.md#list_logs) | **POST** /api/v1/logs-queries/list | Search logs
88

99

1010
# **list_logs**
1111
> LogsListResponse list_logs(body)
1212
13-
Get a list of logs
13+
Search logs
1414

1515
List endpoint returns logs that match a log search query. [Results are paginated][1]. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives
1616

@@ -56,7 +56,7 @@ with ApiClient(configuration) as api_client:
5656

5757
# example passing only required values which don't have defaults set
5858
try:
59-
# Get a list of logs
59+
# Search logs
6060
api_response = api_instance.list_logs(body)
6161
pprint(api_response)
6262
except ApiException as e:

docs/v1/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Class | Method | HTTP request | Description
161161
*KeyManagementApi* | [**list_application_keys**](KeyManagementApi.md#list_application_keys) | **GET** /api/v1/application_key | Get all application keys
162162
*KeyManagementApi* | [**update_api_key**](KeyManagementApi.md#update_api_key) | **PUT** /api/v1/api_key/{key} | Edit an API key
163163
*KeyManagementApi* | [**update_application_key**](KeyManagementApi.md#update_application_key) | **PUT** /api/v1/application_key/{key} | Edit an application key
164-
*LogsApi* | [**list_logs**](LogsApi.md#list_logs) | **POST** /api/v1/logs-queries/list | Get a list of logs
164+
*LogsApi* | [**list_logs**](LogsApi.md#list_logs) | **POST** /api/v1/logs-queries/list | Search logs
165165
*LogsIndexesApi* | [**create_logs_index**](LogsIndexesApi.md#create_logs_index) | **POST** /api/v1/logs/config/indexes | Create an index
166166
*LogsIndexesApi* | [**get_logs_index**](LogsIndexesApi.md#get_logs_index) | **GET** /api/v1/logs/config/indexes/{name} | Get an index
167167
*LogsIndexesApi* | [**get_logs_index_order**](LogsIndexesApi.md#get_logs_index_order) | **GET** /api/v1/logs/config/index-order | Get indexes order

docs/v2/LogsApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ All URIs are relative to *https://api.datadoghq.com*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**aggregate_logs**](LogsApi.md#aggregate_logs) | **POST** /api/v2/logs/analytics/aggregate | Aggregate events
8-
[**list_logs**](LogsApi.md#list_logs) | **POST** /api/v2/logs/events/search | Get a list of logs
9-
[**list_logs_get**](LogsApi.md#list_logs_get) | **GET** /api/v2/logs/events | Get a quick list of logs
8+
[**list_logs**](LogsApi.md#list_logs) | **POST** /api/v2/logs/events/search | Search logs
9+
[**list_logs_get**](LogsApi.md#list_logs_get) | **GET** /api/v2/logs/events | Get a list of logs
1010

1111

1212
# **aggregate_logs**
@@ -126,9 +126,9 @@ Name | Type | Description | Notes
126126
# **list_logs**
127127
> LogsListResponse list_logs()
128128
129-
Get a list of logs
129+
Search logs
130130

131-
List endpoint returns logs that match a log search query. [Results are paginated][1]. Both this endpoint and the GET endpoint can be used interchangeably when listing logs. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives
131+
List endpoint returns logs that match a log search query. [Results are paginated][1]. Use this endpoint to build complex logs filtering and search. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives
132132

133133
### Example
134134

@@ -179,7 +179,7 @@ with ApiClient(configuration) as api_client:
179179
# example passing only required values which don't have defaults set
180180
# and optional values
181181
try:
182-
# Get a list of logs
182+
# Search logs
183183
api_response = api_instance.list_logs(body=body)
184184
pprint(api_response)
185185
except ApiException as e:
@@ -217,9 +217,9 @@ Name | Type | Description | Notes
217217
# **list_logs_get**
218218
> LogsListResponse list_logs_get()
219219
220-
Get a quick list of logs
220+
Get a list of logs
221221

222-
List endpoint returns logs that match a log search query. [Results are paginated][1]. Both this endpoint and the POST endpoint can be used interchangeably when listing logs. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives
222+
List endpoint returns logs that match a log search query. [Results are paginated][1]. Use this endpoint to see your latest logs. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives
223223

224224
### Example
225225

@@ -260,7 +260,7 @@ with ApiClient(configuration) as api_client:
260260
# example passing only required values which don't have defaults set
261261
# and optional values
262262
try:
263-
# Get a quick list of logs
263+
# Get a list of logs
264264
api_response = api_instance.list_logs_get(filter_query=filter_query, filter_index=filter_index, filter_from=filter_from, filter_to=filter_to, sort=sort, page_cursor=page_cursor, page_limit=page_limit)
265265
pprint(api_response)
266266
except ApiException as e:

docs/v2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ Class | Method | HTTP request | Description
133133
*KeyManagementApi* | [**update_application_key**](KeyManagementApi.md#update_application_key) | **PATCH** /api/v2/application_keys/{app_key_id} | Edit an application key
134134
*KeyManagementApi* | [**update_current_user_application_key**](KeyManagementApi.md#update_current_user_application_key) | **PATCH** /api/v2/current_user/application_keys/{app_key_id} | Edit an application key owned by current user
135135
*LogsApi* | [**aggregate_logs**](LogsApi.md#aggregate_logs) | **POST** /api/v2/logs/analytics/aggregate | Aggregate events
136-
*LogsApi* | [**list_logs**](LogsApi.md#list_logs) | **POST** /api/v2/logs/events/search | Get a list of logs
137-
*LogsApi* | [**list_logs_get**](LogsApi.md#list_logs_get) | **GET** /api/v2/logs/events | Get a quick list of logs
136+
*LogsApi* | [**list_logs**](LogsApi.md#list_logs) | **POST** /api/v2/logs/events/search | Search logs
137+
*LogsApi* | [**list_logs_get**](LogsApi.md#list_logs_get) | **GET** /api/v2/logs/events | Get a list of logs
138138
*LogsArchivesApi* | [**add_read_role_to_archive**](LogsArchivesApi.md#add_read_role_to_archive) | **POST** /api/v2/logs/config/archives/{archive_id}/readers | Grant role to an archive
139139
*LogsArchivesApi* | [**create_logs_archive**](LogsArchivesApi.md#create_logs_archive) | **POST** /api/v2/logs/config/archives | Create an archive
140140
*LogsArchivesApi* | [**delete_logs_archive**](LogsArchivesApi.md#delete_logs_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id} | Delete an archive

src/datadog_api_client/v1/api/logs_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def __list_logs(
3939
body,
4040
**kwargs
4141
):
42-
"""Get a list of logs # noqa: E501
42+
"""Search logs # noqa: E501
4343
4444
List endpoint returns logs that match a log search query. [Results are paginated][1]. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives # noqa: E501
4545
This method makes a synchronous HTTP request by default. To make an

src/datadog_api_client/v1/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13056,7 +13056,7 @@ paths:
1305613056
schema:
1305713057
$ref: '#/components/schemas/APIErrorResponse'
1305813058
description: Authentication error
13059-
summary: Get a list of logs
13059+
summary: Search logs
1306013060
tags:
1306113061
- Logs
1306213062
x-codegen-request-body-name: body

src/datadog_api_client/v2/api/logs_api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,9 @@ def __list_logs(
161161
self,
162162
**kwargs
163163
):
164-
"""Get a list of logs # noqa: E501
164+
"""Search logs # noqa: E501
165165
166-
List endpoint returns logs that match a log search query. [Results are paginated][1]. Both this endpoint and the GET endpoint can be used interchangeably when listing logs. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives # noqa: E501
166+
List endpoint returns logs that match a log search query. [Results are paginated][1]. Use this endpoint to build complex logs filtering and search. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives # noqa: E501
167167
This method makes a synchronous HTTP request by default. To make an
168168
asynchronous HTTP request, please pass async_req=True
169169
@@ -276,9 +276,9 @@ def __list_logs_get(
276276
self,
277277
**kwargs
278278
):
279-
"""Get a quick list of logs # noqa: E501
279+
"""Get a list of logs # noqa: E501
280280
281-
List endpoint returns logs that match a log search query. [Results are paginated][1]. Both this endpoint and the POST endpoint can be used interchangeably when listing logs. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives # noqa: E501
281+
List endpoint returns logs that match a log search query. [Results are paginated][1]. Use this endpoint to see your latest logs. **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].** [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives # noqa: E501
282282
This method makes a synchronous HTTP request by default. To make an
283283
asynchronous HTTP request, please pass async_req=True
284284

src/datadog_api_client/v2/openapi.yaml

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5742,10 +5742,7 @@ paths:
57425742
[Results are paginated][1].
57435743
57445744
5745-
Both this endpoint and the POST endpoint can be used interchangeably when
5746-
listing
5747-
5748-
logs.
5745+
Use this endpoint to see your latest logs.
57495746
57505747
57515748
**If you are considering archiving logs for your organization,
@@ -5827,7 +5824,7 @@ paths:
58275824
$ref: '#/components/responses/BadRequestResponse'
58285825
'403':
58295826
$ref: '#/components/responses/NotAuthorizedResponse'
5830-
summary: Get a quick list of logs
5827+
summary: Get a list of logs
58315828
tags:
58325829
- Logs
58335830
x-undo:
@@ -5842,9 +5839,7 @@ paths:
58425839
[Results are paginated][1].
58435840
58445841
5845-
Both this endpoint and the GET endpoint can be used interchangeably when listing
5846-
5847-
logs.
5842+
Use this endpoint to build complex logs filtering and search.
58485843
58495844
58505845
**If you are considering archiving logs for your organization,
@@ -5875,7 +5870,7 @@ paths:
58755870
$ref: '#/components/responses/BadRequestResponse'
58765871
'403':
58775872
$ref: '#/components/responses/NotAuthorizedResponse'
5878-
summary: Get a list of logs
5873+
summary: Search logs
58795874
tags:
58805875
- Logs
58815876
x-codegen-request-body-name: body

tests/v1/features/logs.feature

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ Feature: Logs
2323
And body {}
2424

2525
@generated @skip
26-
Scenario: Get a list of logs returns "Bad Request" response
26+
Scenario: Search logs returns "Bad Request" response
2727
When the request is sent
2828
Then the response status is 400 Bad Request
2929

3030
@generated @skip
31-
Scenario: Get a list of logs returns "OK" response
31+
Scenario: Search logs returns "OK" response
3232
When the request is sent
3333
Then the response status is 200 OK

tests/v2/features/logs.feature

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,8 @@ Feature: Logs
3535

3636
@generated @skip
3737
Scenario: Get a list of logs returns "Bad Request" response
38-
Given operation "ListLogs" enabled
39-
And new "ListLogs" request
40-
And body {}
38+
Given operation "ListLogsGet" enabled
39+
And new "ListLogsGet" request
4140
When the request is sent
4241
Then the response status is 400 Bad Request
4342

@@ -48,13 +47,6 @@ Feature: Logs
4847
When the request is sent
4948
Then the response status is 200 OK
5049

51-
@generated @skip
52-
Scenario: Get a quick list of logs returns "Bad Request" response
53-
Given operation "ListLogsGet" enabled
54-
And new "ListLogsGet" request
55-
When the request is sent
56-
Then the response status is 400 Bad Request
57-
5850
Scenario: Get a quick list of logs returns "OK" response
5951
Given operation "ListLogsGet" enabled
6052
And new "ListLogsGet" request
@@ -65,3 +57,19 @@ Feature: Logs
6557
And request contains "page[limit]" parameter with value 5
6658
When the request is sent
6759
Then the response status is 200 OK
60+
61+
@generated @skip
62+
Scenario: Search logs returns "Bad Request" response
63+
Given operation "ListLogs" enabled
64+
And new "ListLogs" request
65+
And body {}
66+
When the request is sent
67+
Then the response status is 400 Bad Request
68+
69+
@generated @skip
70+
Scenario: Search logs returns "OK" response
71+
Given operation "ListLogs" enabled
72+
And new "ListLogs" request
73+
And body {}
74+
When the request is sent
75+
Then the response status is 200 OK

0 commit comments

Comments
 (0)