Skip to content

Add OpenAPI specs for reporting schedule endpoints #3991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OpenAPI specs for reporting schedule endpoints #3991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,005 changes: 1,002 additions & 3 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion examples/v2/report-schedules/CreateReportSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public static void main(String[] args) {
new ReportScheduleTemplateVariable()
.name("env")
.values(Collections.singletonList("prod"))))
.timeframe("calendar_month")
.timeframe("1w")
.timezone("America/New_York")
.title("Weekly Infrastructure Report"))
.type(ReportScheduleType.SCHEDULE));
Expand Down
26 changes: 26 additions & 0 deletions examples/v2/report-schedules/DeleteReportSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Delete a report schedule returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ReportSchedulesApi;
import com.datadog.api.client.v2.model.ReportScheduleResponse;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient);

try {
ReportScheduleResponse result =
apiInstance.deleteReportSchedule(UUID.fromString("11111111-2222-3333-4444-555555555555"));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportSchedulesApi#deleteReportSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
26 changes: 26 additions & 0 deletions examples/v2/report-schedules/GetReportSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Get a report schedule returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ReportSchedulesApi;
import com.datadog.api.client.v2.model.ReportScheduleResponse;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient);

try {
ReportScheduleResponse result =
apiInstance.getReportSchedule(UUID.fromString("11111111-2222-3333-4444-555555555555"));
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportSchedulesApi#getReportSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
27 changes: 27 additions & 0 deletions examples/v2/report-schedules/GetReportSchedulesForResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
// Get report schedules for a resource returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ReportSchedulesApi;
import com.datadog.api.client.v2.model.ReportScheduleListResponse;
import com.datadog.api.client.v2.model.ReportScheduleResourceType;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient);

try {
ReportScheduleListResponse result =
apiInstance.getReportSchedulesForResource(
ReportScheduleResourceType.DASHBOARD, "abc-def-ghi");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportSchedulesApi#getReportSchedulesForResource");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
24 changes: 24 additions & 0 deletions examples/v2/report-schedules/ListReportSchedules.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// List report schedules returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ReportSchedulesApi;
import com.datadog.api.client.v2.model.ReportScheduleListResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient);

try {
ReportScheduleListResponse result = apiInstance.listReportSchedules();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportSchedulesApi#listReportSchedules");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
2 changes: 1 addition & 1 deletion examples/v2/report-schedules/PatchReportSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public static void main(String[] args) {
new ReportScheduleTemplateVariable()
.name("env")
.values(Collections.singletonList("prod"))))
.timeframe("calendar_month")
.timeframe("1w")
.timezone("America/New_York")
.title("Weekly Infrastructure Report"))
.type(ReportScheduleType.SCHEDULE));
Expand Down
41 changes: 41 additions & 0 deletions examples/v2/report-schedules/ToggleReportSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// Toggle a report schedule returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ReportSchedulesApi;
import com.datadog.api.client.v2.model.ReportScheduleResponse;
import com.datadog.api.client.v2.model.ReportScheduleStatus;
import com.datadog.api.client.v2.model.ReportScheduleToggleRequest;
import com.datadog.api.client.v2.model.ReportScheduleToggleRequestAttributes;
import com.datadog.api.client.v2.model.ReportScheduleToggleRequestData;
import com.datadog.api.client.v2.model.ReportScheduleType;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
ReportSchedulesApi apiInstance = new ReportSchedulesApi(defaultClient);

ReportScheduleToggleRequest body =
new ReportScheduleToggleRequest()
.data(
new ReportScheduleToggleRequestData()
.attributes(
new ReportScheduleToggleRequestAttributes()
.status(ReportScheduleStatus.ACTIVE))
.type(ReportScheduleType.SCHEDULE));

try {
ReportScheduleResponse result =
apiInstance.toggleReportSchedule(
UUID.fromString("11111111-2222-3333-4444-555555555555"), body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportSchedulesApi#toggleReportSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -990,6 +990,8 @@ public class ApiClient {
put("v2.updateDashboardSecureEmbed", false);
put("v2.getDashboardUsage", false);
put("v2.listDashboardsUsage", false);
put("v2.getDataObservabilityMonitorRunStatus", false);
put("v2.runDataObservabilityMonitor", false);
put("v2.createDataset", false);
put("v2.deleteDataset", false);
put("v2.getAllDatasets", false);
Expand Down
Loading
Loading