Skip to content

Commit b53ee46

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add OpenAPI documentation for Synthetics downtime endpoints (#3754)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent b77e306 commit b53ee46

26 files changed

Lines changed: 5666 additions & 34 deletions

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 949 additions & 0 deletions
Large diffs are not rendered by default.

‎examples/v2/synthetics/AddTestToSyntheticsDowntime.java‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Add a test to a Synthetics downtime returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SyntheticsApi;
6+
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
12+
13+
try {
14+
SyntheticsDowntimeResponse result =
15+
apiInstance.addTestToSyntheticsDowntime(
16+
"00000000-0000-0000-0000-000000000001", "abc-def-123");
17+
System.out.println(result);
18+
} catch (ApiException e) {
19+
System.err.println("Exception when calling SyntheticsApi#addTestToSyntheticsDowntime");
20+
System.err.println("Status code: " + e.getCode());
21+
System.err.println("Reason: " + e.getResponseBody());
22+
System.err.println("Response headers: " + e.getResponseHeaders());
23+
e.printStackTrace();
24+
}
25+
}
26+
}

‎examples/v2/synthetics/CreateSyntheticsDowntime.java‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// Create a Synthetics downtime returns "Created" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SyntheticsApi;
6+
import com.datadog.api.client.v2.model.SyntheticsDowntimeDataAttributesRequest;
7+
import com.datadog.api.client.v2.model.SyntheticsDowntimeDataRequest;
8+
import com.datadog.api.client.v2.model.SyntheticsDowntimeRequest;
9+
import com.datadog.api.client.v2.model.SyntheticsDowntimeResourceType;
10+
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;
11+
import com.datadog.api.client.v2.model.SyntheticsDowntimeTimeSlotDate;
12+
import com.datadog.api.client.v2.model.SyntheticsDowntimeTimeSlotRequest;
13+
import java.util.Collections;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
19+
20+
SyntheticsDowntimeRequest body =
21+
new SyntheticsDowntimeRequest()
22+
.data(
23+
new SyntheticsDowntimeDataRequest()
24+
.attributes(
25+
new SyntheticsDowntimeDataAttributesRequest()
26+
.isEnabled(true)
27+
.name("Weekly maintenance")
28+
.testIds(Collections.singletonList("abc-def-123"))
29+
.timeSlots(
30+
Collections.singletonList(
31+
new SyntheticsDowntimeTimeSlotRequest()
32+
.duration(3600L)
33+
.start(
34+
new SyntheticsDowntimeTimeSlotDate()
35+
.day(15L)
36+
.hour(10L)
37+
.minute(30L)
38+
.month(1L)
39+
.year(2024L))
40+
.timezone("Europe/Paris"))))
41+
.type(SyntheticsDowntimeResourceType.DOWNTIME));
42+
43+
try {
44+
SyntheticsDowntimeResponse result = apiInstance.createSyntheticsDowntime(body);
45+
System.out.println(result);
46+
} catch (ApiException e) {
47+
System.err.println("Exception when calling SyntheticsApi#createSyntheticsDowntime");
48+
System.err.println("Status code: " + e.getCode());
49+
System.err.println("Reason: " + e.getResponseBody());
50+
System.err.println("Response headers: " + e.getResponseHeaders());
51+
e.printStackTrace();
52+
}
53+
}
54+
}

‎examples/v2/synthetics/DeleteSyntheticsDowntime.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Delete a Synthetics downtime returns "No Content" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SyntheticsApi;
6+
7+
public class Example {
8+
public static void main(String[] args) {
9+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
10+
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
11+
12+
try {
13+
apiInstance.deleteSyntheticsDowntime("00000000-0000-0000-0000-000000000001");
14+
} catch (ApiException e) {
15+
System.err.println("Exception when calling SyntheticsApi#deleteSyntheticsDowntime");
16+
System.err.println("Status code: " + e.getCode());
17+
System.err.println("Reason: " + e.getResponseBody());
18+
System.err.println("Response headers: " + e.getResponseHeaders());
19+
e.printStackTrace();
20+
}
21+
}
22+
}

‎examples/v2/synthetics/GetSyntheticsDowntime.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Get a Synthetics downtime returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SyntheticsApi;
6+
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
12+
13+
try {
14+
SyntheticsDowntimeResponse result =
15+
apiInstance.getSyntheticsDowntime("00000000-0000-0000-0000-000000000001");
16+
System.out.println(result);
17+
} catch (ApiException e) {
18+
System.err.println("Exception when calling SyntheticsApi#getSyntheticsDowntime");
19+
System.err.println("Status code: " + e.getCode());
20+
System.err.println("Reason: " + e.getResponseBody());
21+
System.err.println("Response headers: " + e.getResponseHeaders());
22+
e.printStackTrace();
23+
}
24+
}
25+
}

‎examples/v2/synthetics/ListSyntheticsDowntimes.java‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// List Synthetics downtimes returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SyntheticsApi;
6+
import com.datadog.api.client.v2.model.SyntheticsDowntimesResponse;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
12+
13+
try {
14+
SyntheticsDowntimesResponse result = apiInstance.listSyntheticsDowntimes();
15+
System.out.println(result);
16+
} catch (ApiException e) {
17+
System.err.println("Exception when calling SyntheticsApi#listSyntheticsDowntimes");
18+
System.err.println("Status code: " + e.getCode());
19+
System.err.println("Reason: " + e.getResponseBody());
20+
System.err.println("Response headers: " + e.getResponseHeaders());
21+
e.printStackTrace();
22+
}
23+
}
24+
}

‎examples/v2/synthetics/RemoveTestFromSyntheticsDowntime.java‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Remove a test from a Synthetics downtime returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SyntheticsApi;
6+
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;
7+
8+
public class Example {
9+
public static void main(String[] args) {
10+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
11+
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
12+
13+
try {
14+
SyntheticsDowntimeResponse result =
15+
apiInstance.removeTestFromSyntheticsDowntime(
16+
"00000000-0000-0000-0000-000000000001", "abc-def-123");
17+
System.out.println(result);
18+
} catch (ApiException e) {
19+
System.err.println("Exception when calling SyntheticsApi#removeTestFromSyntheticsDowntime");
20+
System.err.println("Status code: " + e.getCode());
21+
System.err.println("Reason: " + e.getResponseBody());
22+
System.err.println("Response headers: " + e.getResponseHeaders());
23+
e.printStackTrace();
24+
}
25+
}
26+
}

‎examples/v2/synthetics/UpdateSyntheticsDowntime.java‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Update a Synthetics downtime returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.SyntheticsApi;
6+
import com.datadog.api.client.v2.model.SyntheticsDowntimeDataAttributesRequest;
7+
import com.datadog.api.client.v2.model.SyntheticsDowntimeDataRequest;
8+
import com.datadog.api.client.v2.model.SyntheticsDowntimeRequest;
9+
import com.datadog.api.client.v2.model.SyntheticsDowntimeResourceType;
10+
import com.datadog.api.client.v2.model.SyntheticsDowntimeResponse;
11+
import com.datadog.api.client.v2.model.SyntheticsDowntimeTimeSlotDate;
12+
import com.datadog.api.client.v2.model.SyntheticsDowntimeTimeSlotRequest;
13+
import java.util.Collections;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
SyntheticsApi apiInstance = new SyntheticsApi(defaultClient);
19+
20+
SyntheticsDowntimeRequest body =
21+
new SyntheticsDowntimeRequest()
22+
.data(
23+
new SyntheticsDowntimeDataRequest()
24+
.attributes(
25+
new SyntheticsDowntimeDataAttributesRequest()
26+
.isEnabled(true)
27+
.name("Weekly maintenance")
28+
.testIds(Collections.singletonList("abc-def-123"))
29+
.timeSlots(
30+
Collections.singletonList(
31+
new SyntheticsDowntimeTimeSlotRequest()
32+
.duration(3600L)
33+
.start(
34+
new SyntheticsDowntimeTimeSlotDate()
35+
.day(15L)
36+
.hour(10L)
37+
.minute(30L)
38+
.month(1L)
39+
.year(2024L))
40+
.timezone("Europe/Paris"))))
41+
.type(SyntheticsDowntimeResourceType.DOWNTIME));
42+
43+
try {
44+
SyntheticsDowntimeResponse result =
45+
apiInstance.updateSyntheticsDowntime("00000000-0000-0000-0000-000000000001", body);
46+
System.out.println(result);
47+
} catch (ApiException e) {
48+
System.err.println("Exception when calling SyntheticsApi#updateSyntheticsDowntime");
49+
System.err.println("Status code: " + e.getCode());
50+
System.err.println("Reason: " + e.getResponseBody());
51+
System.err.println("Response headers: " + e.getResponseHeaders());
52+
e.printStackTrace();
53+
}
54+
}
55+
}

0 commit comments

Comments
 (0)