Skip to content

Add public OpenAPI spec for report schedule create and update #3937

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 public OpenAPI spec for report schedule create and update #3937

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
594 changes: 594 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

64 changes: 64 additions & 0 deletions examples/v2/report-schedules/CreateReportSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
// Create a report schedule returns "CREATED" 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.ReportScheduleCreateRequest;
import com.datadog.api.client.v2.model.ReportScheduleCreateRequestAttributes;
import com.datadog.api.client.v2.model.ReportScheduleCreateRequestData;
import com.datadog.api.client.v2.model.ReportScheduleDeliveryFormat;
import com.datadog.api.client.v2.model.ReportScheduleResourceType;
import com.datadog.api.client.v2.model.ReportScheduleResponse;
import com.datadog.api.client.v2.model.ReportScheduleTemplateVariable;
import com.datadog.api.client.v2.model.ReportScheduleType;
import java.util.Arrays;
import java.util.Collections;

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

ReportScheduleCreateRequest body =
new ReportScheduleCreateRequest()
.data(
new ReportScheduleCreateRequestData()
.attributes(
new ReportScheduleCreateRequestAttributes()
.deliveryFormat(ReportScheduleDeliveryFormat.PDF)
.description("Weekly summary of infrastructure health.")
.recipients(
Arrays.asList(
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"))
.resourceId("abc-def-ghi")
.resourceType(ReportScheduleResourceType.DASHBOARD)
.rrule(
"""
DTSTART;TZID=America/New_York:20260601T090000
RRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0
""")
.tabId("66666666-7777-8888-9999-000000000000")
.templateVariables(
Collections.singletonList(
new ReportScheduleTemplateVariable()
.name("env")
.values(Collections.singletonList("prod"))))
.timeframe("1w")
.timezone("America/New_York")
.title("Weekly Infrastructure Report"))
.type(ReportScheduleType.SCHEDULE));

try {
ReportScheduleResponse result = apiInstance.createReportSchedule(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportSchedulesApi#createReportSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
64 changes: 64 additions & 0 deletions examples/v2/report-schedules/PatchReportSchedule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
// Update 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.ReportScheduleDeliveryFormat;
import com.datadog.api.client.v2.model.ReportSchedulePatchRequest;
import com.datadog.api.client.v2.model.ReportSchedulePatchRequestAttributes;
import com.datadog.api.client.v2.model.ReportSchedulePatchRequestData;
import com.datadog.api.client.v2.model.ReportScheduleResponse;
import com.datadog.api.client.v2.model.ReportScheduleTemplateVariable;
import com.datadog.api.client.v2.model.ReportScheduleType;
import java.util.Arrays;
import java.util.Collections;
import java.util.UUID;

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

ReportSchedulePatchRequest body =
new ReportSchedulePatchRequest()
.data(
new ReportSchedulePatchRequestData()
.attributes(
new ReportSchedulePatchRequestAttributes()
.deliveryFormat(ReportScheduleDeliveryFormat.PDF)
.description("Updated weekly summary of infrastructure health.")
.recipients(
Arrays.asList(
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2"))
.rrule(
"""
DTSTART;TZID=America/New_York:20260601T090000
RRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0
""")
.tabId(UUID.fromString("66666666-7777-8888-9999-000000000000"))
.templateVariables(
Collections.singletonList(
new ReportScheduleTemplateVariable()
.name("env")
.values(Collections.singletonList("prod"))))
.timeframe("1w")
.timezone("America/New_York")
.title("Weekly Infrastructure Report"))
.type(ReportScheduleType.SCHEDULE));

try {
ReportScheduleResponse result =
apiInstance.patchReportSchedule(
UUID.fromString("11111111-2222-3333-4444-555555555555"), body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportSchedulesApi#patchReportSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading
Loading