From 08c8612166ac9239dc38951c769f2f4990eb3aa7 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Fri, 3 Jan 2025 15:58:38 +0000 Subject: [PATCH] Regenerate client from commit 50c16e5f of spec repo --- .apigentools-info | 8 +-- .generator/schemas/v2/openapi.yaml | 8 +-- examples/v2/logs/ListLogs.ts | 20 ++++--- examples/v2/logs/ListLogsGet.ts | 2 +- examples/v2/logs/ListLogsGet_175182691.ts | 18 +++++++ examples/v2/logs/ListLogs_3400928236.ts | 32 +++++++++++ examples/v2/logs/ListLogs_534975433.ts | 39 ++++++++++++++ features/v2/logs.feature | 53 +++++++++++++------ .../datadog-api-client-v2/apis/LogsApi.ts | 4 +- 9 files changed, 151 insertions(+), 33 deletions(-) create mode 100644 examples/v2/logs/ListLogsGet_175182691.ts create mode 100644 examples/v2/logs/ListLogs_3400928236.ts create mode 100644 examples/v2/logs/ListLogs_534975433.ts diff --git a/.apigentools-info b/.apigentools-info index 1358f1970b33..c69bdebc487e 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-01-02 17:32:16.354936", - "spec_repo_commit": "733cf3ea" + "regenerated": "2025-01-03 15:57:06.622528", + "spec_repo_commit": "50c16e5f" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-01-02 17:32:16.370268", - "spec_repo_commit": "733cf3ea" + "regenerated": "2025-01-03 15:57:06.637357", + "spec_repo_commit": "50c16e5f" } } } \ No newline at end of file diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 76195d0bb3d0..5ffff4300a17 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -38621,7 +38621,7 @@ paths: [Results are paginated][1]. - Use this endpoint to see your latest logs. + Use this endpoint to search and filter your logs. **If you are considering archiving logs for your organization, @@ -38718,7 +38718,7 @@ paths: $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Get a list of logs + summary: Search logs (GET) tags: - Logs x-pagination: @@ -38737,7 +38737,7 @@ paths: [Results are paginated][1]. - Use this endpoint to build complex logs filtering and search. + Use this endpoint to search and filter your logs. **If you are considering archiving logs for your organization, @@ -38770,7 +38770,7 @@ paths: $ref: '#/components/responses/NotAuthorizedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' - summary: Search logs + summary: Search logs (POST) tags: - Logs x-codegen-request-body-name: body diff --git a/examples/v2/logs/ListLogs.ts b/examples/v2/logs/ListLogs.ts index 1116514a2090..760e1ed53f97 100644 --- a/examples/v2/logs/ListLogs.ts +++ b/examples/v2/logs/ListLogs.ts @@ -1,5 +1,5 @@ /** - * Search logs returns "OK" response + * Search logs (POST) returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; @@ -10,15 +10,21 @@ const apiInstance = new v2.LogsApi(configuration); const params: v2.LogsApiListLogsRequest = { body: { filter: { - query: "datadog-agent", - indexes: ["main"], - from: "2020-09-17T11:48:36+01:00", - to: "2020-09-17T12:48:36+01:00", + from: "now-15m", + indexes: ["main", "web"], + query: "service:web* AND @http.status_code:[200 TO 299]", + storageTier: "indexes", + to: "now", + }, + options: { + timezone: "GMT", }, - sort: "timestamp", page: { - limit: 5, + cursor: + "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + limit: 25, }, + sort: "timestamp", }, }; diff --git a/examples/v2/logs/ListLogsGet.ts b/examples/v2/logs/ListLogsGet.ts index 3e0205f8b755..3a0a8aa709b4 100644 --- a/examples/v2/logs/ListLogsGet.ts +++ b/examples/v2/logs/ListLogsGet.ts @@ -1,5 +1,5 @@ /** - * Get a list of logs returns "OK" response + * Search logs (GET) returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; diff --git a/examples/v2/logs/ListLogsGet_175182691.ts b/examples/v2/logs/ListLogsGet_175182691.ts new file mode 100644 index 000000000000..7b2dd839938e --- /dev/null +++ b/examples/v2/logs/ListLogsGet_175182691.ts @@ -0,0 +1,18 @@ +/** + * Search logs (GET) returns "OK" response with pagination + */ + +import { client, v2 } from "@datadog/datadog-api-client"; + +const configuration = client.createConfiguration(); +const apiInstance = new v2.LogsApi(configuration); + +(async () => { + try { + for await (const item of apiInstance.listLogsGetWithPagination()) { + console.log(item); + } + } catch (error) { + console.error(error); + } +})(); diff --git a/examples/v2/logs/ListLogs_3400928236.ts b/examples/v2/logs/ListLogs_3400928236.ts new file mode 100644 index 000000000000..1116514a2090 --- /dev/null +++ b/examples/v2/logs/ListLogs_3400928236.ts @@ -0,0 +1,32 @@ +/** + * Search logs returns "OK" response + */ + +import { client, v2 } from "@datadog/datadog-api-client"; + +const configuration = client.createConfiguration(); +const apiInstance = new v2.LogsApi(configuration); + +const params: v2.LogsApiListLogsRequest = { + body: { + filter: { + query: "datadog-agent", + indexes: ["main"], + from: "2020-09-17T11:48:36+01:00", + to: "2020-09-17T12:48:36+01:00", + }, + sort: "timestamp", + page: { + limit: 5, + }, + }, +}; + +apiInstance + .listLogs(params) + .then((data: v2.LogsListResponse) => { + console.log( + "API called successfully. Returned data: " + JSON.stringify(data) + ); + }) + .catch((error: any) => console.error(error)); diff --git a/examples/v2/logs/ListLogs_534975433.ts b/examples/v2/logs/ListLogs_534975433.ts new file mode 100644 index 000000000000..36cb33239cc4 --- /dev/null +++ b/examples/v2/logs/ListLogs_534975433.ts @@ -0,0 +1,39 @@ +/** + * Search logs (POST) returns "OK" response with pagination + */ + +import { client, v2 } from "@datadog/datadog-api-client"; + +const configuration = client.createConfiguration(); +const apiInstance = new v2.LogsApi(configuration); + +const params: v2.LogsApiListLogsRequest = { + body: { + filter: { + from: "now-15m", + indexes: ["main", "web"], + query: "service:web* AND @http.status_code:[200 TO 299]", + storageTier: "indexes", + to: "now", + }, + options: { + timezone: "GMT", + }, + page: { + cursor: + "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", + limit: 25, + }, + sort: "timestamp", + }, +}; + +(async () => { + try { + for await (const item of apiInstance.listLogsWithPagination(params)) { + console.log(item); + } + } catch (error) { + console.error(error); + } +})(); diff --git a/features/v2/logs.feature b/features/v2/logs.feature index 7763729af5fd..b7accd07dd99 100644 --- a/features/v2/logs.feature +++ b/features/v2/logs.feature @@ -43,20 +43,6 @@ Feature: Logs Then the response status is 200 OK And the response "meta.status" is equal to "done" - @generated @skip @team:DataDog/logs-app - Scenario: Get a list of logs returns "Bad Request" response - Given a valid "appKeyAuth" key in the system - And new "ListLogsGet" request - When the request is sent - Then the response status is 400 Bad Request - - @generated @skip @team:DataDog/logs-app - Scenario: Get a list of logs returns "OK" response - Given a valid "appKeyAuth" key in the system - And new "ListLogsGet" request - When the request is sent - Then the response status is 200 OK - @replay-only @skip-validation @team:DataDog/logs-app @with-pagination Scenario: Get a list of logs returns "OK" response with pagination Given a valid "appKeyAuth" key in the system @@ -80,13 +66,50 @@ Feature: Logs And the response "data" has length 0 @generated @skip @team:DataDog/logs-app - Scenario: Search logs returns "Bad Request" response + Scenario: Search logs (GET) returns "Bad Request" response + Given a valid "appKeyAuth" key in the system + And new "ListLogsGet" request + When the request is sent + Then the response status is 400 Bad Request + + @generated @skip @team:DataDog/logs-app + Scenario: Search logs (GET) returns "OK" response + Given a valid "appKeyAuth" key in the system + And new "ListLogsGet" request + When the request is sent + Then the response status is 200 OK + + @generated @skip @team:DataDog/logs-app @with-pagination + Scenario: Search logs (GET) returns "OK" response with pagination + Given a valid "appKeyAuth" key in the system + And new "ListLogsGet" request + When the request with pagination is sent + Then the response status is 200 OK + + @generated @skip @team:DataDog/logs-app + Scenario: Search logs (POST) returns "Bad Request" response Given a valid "appKeyAuth" key in the system And new "ListLogs" request And body with value {"filter": {"from": "now-15m", "indexes": ["main", "web"], "query": "service:web* AND @http.status_code:[200 TO 299]", "storage_tier": "indexes", "to": "now"}, "options": {"timezone": "GMT"}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "timestamp"} When the request is sent Then the response status is 400 Bad Request + @generated @skip @team:DataDog/logs-app + Scenario: Search logs (POST) returns "OK" response + Given a valid "appKeyAuth" key in the system + And new "ListLogs" request + And body with value {"filter": {"from": "now-15m", "indexes": ["main", "web"], "query": "service:web* AND @http.status_code:[200 TO 299]", "storage_tier": "indexes", "to": "now"}, "options": {"timezone": "GMT"}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "timestamp"} + When the request is sent + Then the response status is 200 OK + + @generated @skip @team:DataDog/logs-app @with-pagination + Scenario: Search logs (POST) returns "OK" response with pagination + Given a valid "appKeyAuth" key in the system + And new "ListLogs" request + And body with value {"filter": {"from": "now-15m", "indexes": ["main", "web"], "query": "service:web* AND @http.status_code:[200 TO 299]", "storage_tier": "indexes", "to": "now"}, "options": {"timezone": "GMT"}, "page": {"cursor": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==", "limit": 25}, "sort": "timestamp"} + When the request with pagination is sent + Then the response status is 200 OK + @team:DataDog/logs-app Scenario: Search logs returns "OK" response Given a valid "appKeyAuth" key in the system diff --git a/packages/datadog-api-client-v2/apis/LogsApi.ts b/packages/datadog-api-client-v2/apis/LogsApi.ts index 04892330417d..57fc63bfc094 100644 --- a/packages/datadog-api-client-v2/apis/LogsApi.ts +++ b/packages/datadog-api-client-v2/apis/LogsApi.ts @@ -626,7 +626,7 @@ export class LogsApi { * List endpoint returns logs that match a log search query. * [Results are paginated][1]. * - * Use this endpoint to build complex logs filtering and search. + * Use this endpoint to search and filter your logs. * * **If you are considering archiving logs for your organization, * consider use of the Datadog archive capabilities instead of the log list API. @@ -713,7 +713,7 @@ export class LogsApi { * List endpoint returns logs that match a log search query. * [Results are paginated][1]. * - * Use this endpoint to see your latest logs. + * Use this endpoint to search and filter your logs. * * **If you are considering archiving logs for your organization, * consider use of the Datadog archive capabilities instead of the log list API.