Generate pagination examples (#776)

* generate pagination examples

* spacing

* support older js version syntax

* pre-commit fixes

* pre-commit fixes

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: skarimo

.generator/conftest.py

@@ -105,7 +105,7 @@ def pytest_bdd_after_scenario(request, feature, scenario):
 
 def pytest_bdd_apply_tag(tag, function):
     """Register tags as custom markers and skip test for '@skip' ones."""
-    skip_tags = {"with-pagination"}
+    skip_tags = {}
     if tag in skip_tags:
         marker = pytest.mark.skip(reason=f"skipped because '{tag}' in {skip_tags}")
         marker(function)
@@ -442,6 +442,7 @@ def execute_request(context, api_version):
 @when("the request with pagination is sent")
 def execute_request_with_pagination(context):
     """Execute the prepared request paginated."""
+    context["pagination"] = True
 
 
 @then(parsers.parse("the response status is {status:d} {description}"))

.generator/src/generator/templates/example.j2

@@ -53,9 +53,24 @@ const params: {{ version }}.{{ context.api_instance.name }}Api{{ context.api_req
 };
 {%- endif %}
 
+{%- if context.pagination %}
+
+(async () => {
+  try {
+    for await (const item of apiInstance.{{ context.api_request.operation_id|untitle_case }}WithPagination({% if has_params %}params{% endif %})) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error)
+  }
+})();
+
+{%- else %}
+
 apiInstance
   .{{ context.api_request.operation_id|untitle_case }}({% if has_params %}params{% endif %})
   .then((data: {% if api_response_type %}{{ api_response_type }}{% else %}any{% endif %}) => {
     console.log("API called successfully. Returned data: " + JSON.stringify(data));
   })
   .catch((error: any) => console.error(error));
+{%-endif %}

examples/v2/audit/ListAuditLogs_1275402458.ts

@@ -0,0 +1,22 @@
+/**
+ * Get a list of Audit Logs events returns "OK" response with pagination
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.AuditApi(configuration);
+
+const params: v2.AuditApiListAuditLogsRequest = {
+  pageLimit: 2,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listAuditLogsWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

examples/v2/audit/SearchAuditLogs_3215529662.ts

@@ -0,0 +1,36 @@
+/**
+ * Search Audit Logs events returns "OK" response with pagination
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.AuditApi(configuration);
+
+const params: v2.AuditApiSearchAuditLogsRequest = {
+  body: {
+    filter: {
+      from: "now-15m",
+      to: "now",
+    },
+    options: {
+      timezone: "GMT",
+    },
+    page: {
+      limit: 2,
+    },
+    sort: "timestamp",
+  },
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.searchAuditLogsWithPagination(
+      params
+    )) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

examples/v2/events/ListEvents_1527584014.ts

@@ -0,0 +1,25 @@
+/**
+ * Get a list of events returns "OK" response with pagination
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.listEvents"] = true;
+const apiInstance = new v2.EventsApi(configuration);
+
+const params: v2.EventsApiListEventsRequest = {
+  filterFrom: "now-15m",
+  filterTo: "now",
+  pageLimit: 2,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listEventsWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

examples/v2/events/SearchEvents_3856995058.ts

@@ -0,0 +1,35 @@
+/**
+ * Search events returns "OK" response with pagination
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.searchEvents"] = true;
+const apiInstance = new v2.EventsApi(configuration);
+
+const params: v2.EventsApiSearchEventsRequest = {
+  body: {
+    filter: {
+      from: "now-15m",
+      to: "now",
+    },
+    options: {
+      timezone: "GMT",
+    },
+    page: {
+      limit: 2,
+    },
+    sort: "timestamp",
+  },
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.searchEventsWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

examples/v2/incidents/ListIncidents_2665616954.ts

@@ -0,0 +1,23 @@
+/**
+ * Get a list of incidents returns "OK" response with pagination
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.listIncidents"] = true;
+const apiInstance = new v2.IncidentsApi(configuration);
+
+const params: v2.IncidentsApiListIncidentsRequest = {
+  pageSize: 2,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listIncidentsWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

examples/v2/logs/ListLogsGet_738202670.ts

@@ -0,0 +1,22 @@
+/**
+ * Get a list of logs 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.LogsApiListLogsGetRequest = {
+  pageLimit: 2,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listLogsGetWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

examples/v2/logs/ListLogs_3138392594.ts

@@ -0,0 +1,35 @@
+/**
+ * Search logs 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"],
+      to: "now",
+    },
+    options: {
+      timezone: "GMT",
+    },
+    page: {
+      limit: 2,
+    },
+    sort: "timestamp",
+  },
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listLogsWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

examples/v2/processes/ListProcesses_797840471.ts

@@ -0,0 +1,22 @@
+/**
+ * Get all processes returns "OK" response with pagination
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.ProcessesApi(configuration);
+
+const params: v2.ProcessesApiListProcessesRequest = {
+  pageLimit: 2,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listProcessesWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();