Skip to content

Add OpenAPI documentation for Synthetics downtime endpoints #3754

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 documentation for Synthetics downtime endpoints #3754

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

Large diffs are not rendered by default.

26 changes: 26 additions & 0 deletions examples/v2/synthetics/AddTestToSyntheticsDowntime.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Add a test to a Synthetics downtime returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SyntheticsApi;
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;

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

try {
SyntheticsDowntimeResponse result =
apiInstance.addTestToSyntheticsDowntime(
"00000000-0000-0000-0000-000000000001", "abc-def-123");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#addTestToSyntheticsDowntime");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
54 changes: 54 additions & 0 deletions examples/v2/synthetics/CreateSyntheticsDowntime.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Create a Synthetics downtime returns "Created" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SyntheticsApi;
import com.datadog.api.client.v2.model.SyntheticsDowntimeDataAttributesRequest;
import com.datadog.api.client.v2.model.SyntheticsDowntimeDataRequest;
import com.datadog.api.client.v2.model.SyntheticsDowntimeRequest;
import com.datadog.api.client.v2.model.SyntheticsDowntimeResourceType;
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;
import com.datadog.api.client.v2.model.SyntheticsDowntimeTimeSlotDate;
import com.datadog.api.client.v2.model.SyntheticsDowntimeTimeSlotRequest;
import java.util.Collections;

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

SyntheticsDowntimeRequest body =
new SyntheticsDowntimeRequest()
.data(
new SyntheticsDowntimeDataRequest()
.attributes(
new SyntheticsDowntimeDataAttributesRequest()
.isEnabled(true)
.name("Weekly maintenance")
.testIds(Collections.singletonList("abc-def-123"))
.timeSlots(
Collections.singletonList(
new SyntheticsDowntimeTimeSlotRequest()
.duration(3600L)
.start(
new SyntheticsDowntimeTimeSlotDate()
.day(15L)
.hour(10L)
.minute(30L)
.month(1L)
.year(2024L))
.timezone("Europe/Paris"))))
.type(SyntheticsDowntimeResourceType.DOWNTIME));

try {
SyntheticsDowntimeResponse result = apiInstance.createSyntheticsDowntime(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#createSyntheticsDowntime");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
22 changes: 22 additions & 0 deletions examples/v2/synthetics/DeleteSyntheticsDowntime.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// Delete a Synthetics downtime returns "No Content" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SyntheticsApi;

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

try {
apiInstance.deleteSyntheticsDowntime("00000000-0000-0000-0000-000000000001");
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#deleteSyntheticsDowntime");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
25 changes: 25 additions & 0 deletions examples/v2/synthetics/GetSyntheticsDowntime.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Get a Synthetics downtime returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SyntheticsApi;
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;

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

try {
SyntheticsDowntimeResponse result =
apiInstance.getSyntheticsDowntime("00000000-0000-0000-0000-000000000001");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#getSyntheticsDowntime");
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/synthetics/ListSyntheticsDowntimes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// List Synthetics downtimes returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SyntheticsApi;
import com.datadog.api.client.v2.model.SyntheticsDowntimesResponse;

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

try {
SyntheticsDowntimesResponse result = apiInstance.listSyntheticsDowntimes();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#listSyntheticsDowntimes");
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/synthetics/RemoveTestFromSyntheticsDowntime.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Remove a test from a Synthetics downtime returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SyntheticsApi;
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;

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

try {
SyntheticsDowntimeResponse result =
apiInstance.removeTestFromSyntheticsDowntime(
"00000000-0000-0000-0000-000000000001", "abc-def-123");
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#removeTestFromSyntheticsDowntime");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
55 changes: 55 additions & 0 deletions examples/v2/synthetics/UpdateSyntheticsDowntime.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
// Update a Synthetics downtime returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SyntheticsApi;
import com.datadog.api.client.v2.model.SyntheticsDowntimeDataAttributesRequest;
import com.datadog.api.client.v2.model.SyntheticsDowntimeDataRequest;
import com.datadog.api.client.v2.model.SyntheticsDowntimeRequest;
import com.datadog.api.client.v2.model.SyntheticsDowntimeResourceType;
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;
import com.datadog.api.client.v2.model.SyntheticsDowntimeTimeSlotDate;
import com.datadog.api.client.v2.model.SyntheticsDowntimeTimeSlotRequest;
import java.util.Collections;

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

SyntheticsDowntimeRequest body =
new SyntheticsDowntimeRequest()
.data(
new SyntheticsDowntimeDataRequest()
.attributes(
new SyntheticsDowntimeDataAttributesRequest()
.isEnabled(true)
.name("Weekly maintenance")
.testIds(Collections.singletonList("abc-def-123"))
.timeSlots(
Collections.singletonList(
new SyntheticsDowntimeTimeSlotRequest()
.duration(3600L)
.start(
new SyntheticsDowntimeTimeSlotDate()
.day(15L)
.hour(10L)
.minute(30L)
.month(1L)
.year(2024L))
.timezone("Europe/Paris"))))
.type(SyntheticsDowntimeResourceType.DOWNTIME));

try {
SyntheticsDowntimeResponse result =
apiInstance.updateSyntheticsDowntime("00000000-0000-0000-0000-000000000001", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SyntheticsApi#updateSyntheticsDowntime");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Loading
Loading