Skip to content

Commit 1bbdac6

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
[chores] Clean up Synthetics API Reference menu sidebar (#3522)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 5def671 commit 1bbdac6

File tree

48 files changed

+607
-774
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+607
-774
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35525,7 +35525,7 @@ paths:
3552535525
get:
3552635526
description: 'Get the detailed configuration associated with
3552735527

35528-
a Synthetic Mobile test.'
35528+
a Synthetic mobile test.'
3552935529
operationId: GetMobileTest
3553035530
parameters:
3553135531
- description: The public ID of the test to get details from.
@@ -35562,15 +35562,15 @@ paths:
3556235562
appKeyAuth: []
3556335563
- AuthZ:
3556435564
- synthetics_read
35565-
summary: Get a Mobile test
35565+
summary: Get a mobile test
3556635566
tags:
3556735567
- Synthetics
3556835568
x-permission:
3556935569
operator: OR
3557035570
permissions:
3557135571
- synthetics_read
3557235572
put:
35573-
description: Edit the configuration of a Synthetic Mobile test.
35573+
description: Edit the configuration of a Synthetic mobile test.
3557435574
operationId: UpdateMobileTest
3557535575
parameters:
3557635576
- description: The public ID of the test to get details from.
@@ -35624,7 +35624,7 @@ paths:
3562435624
appKeyAuth: []
3562535625
- AuthZ:
3562635626
- synthetics_write
35627-
summary: Edit a Mobile test
35627+
summary: Edit a mobile test
3562835628
tags:
3562935629
- Synthetics
3563035630
x-codegen-request-body-name: body

.generator/schemas/v2/openapi.yaml

Lines changed: 10 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -32179,53 +32179,6 @@ components:
3217932179
type: string
3218032180
type: array
3218132181
type: object
32182-
Integration:
32183-
description: Integration resource object.
32184-
properties:
32185-
attributes:
32186-
$ref: '#/components/schemas/IntegrationAttributes'
32187-
id:
32188-
description: The unique identifier of the integration.
32189-
example: calico
32190-
type: string
32191-
links:
32192-
$ref: '#/components/schemas/IntegrationLinks'
32193-
type:
32194-
$ref: '#/components/schemas/IntegrationType'
32195-
required:
32196-
- type
32197-
- id
32198-
- attributes
32199-
type: object
32200-
IntegrationAttributes:
32201-
description: Attributes for an integration.
32202-
properties:
32203-
categories:
32204-
description: List of categories associated with the integration.
32205-
example:
32206-
- Category::Kubernetes
32207-
- Category::Log Collection
32208-
items:
32209-
type: string
32210-
type: array
32211-
description:
32212-
description: A description of the integration.
32213-
example: Calico is a networking and network security solution for containers.
32214-
type: string
32215-
installed:
32216-
description: Whether the integration is installed.
32217-
example: true
32218-
type: boolean
32219-
title:
32220-
description: The name of the integration.
32221-
example: calico
32222-
type: string
32223-
required:
32224-
- title
32225-
- description
32226-
- categories
32227-
- installed
32228-
type: object
3222932182
IntegrationIncident:
3223032183
description: Incident integration settings
3223132184
properties:
@@ -32331,14 +32284,6 @@ components:
3233132284
value:
3233232285
$ref: '#/components/schemas/AnyValue'
3233332286
type: object
32334-
IntegrationLinks:
32335-
description: Links for the integration resource.
32336-
properties:
32337-
self:
32338-
description: Link to the integration resource.
32339-
example: /integrations?integrationId=calico
32340-
type: string
32341-
type: object
3234232287
IntegrationMonitor:
3234332288
description: Monitor integration settings
3234432289
properties:
@@ -32440,15 +32385,6 @@ components:
3244032385
type: string
3244132386
type: object
3244232387
type: object
32443-
IntegrationType:
32444-
default: integration
32445-
description: Integration resource type.
32446-
enum:
32447-
- integration
32448-
example: integration
32449-
type: string
32450-
x-enum-varnames:
32451-
- INTEGRATION
3245232388
InterfaceAttributes:
3245332389
description: The interface attributes
3245432390
properties:
@@ -34840,17 +34776,6 @@ components:
3484034776
- data
3484134777
- meta
3484234778
type: object
34843-
ListIntegrationsResponse:
34844-
description: Response containing information about multiple integrations.
34845-
properties:
34846-
data:
34847-
description: Array of integration objects.
34848-
items:
34849-
$ref: '#/components/schemas/Integration'
34850-
type: array
34851-
required:
34852-
- data
34853-
type: object
3485434779
ListInterfaceTagsResponse:
3485534780
description: Response for listing interface tags.
3485634781
properties:
@@ -84280,24 +84205,6 @@ paths:
8428084205
x-unstable: '**Note**: This endpoint is in public beta and is subject to change.
8428184206

8428284207
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
84283-
/api/v2/integrations:
84284-
get:
84285-
operationId: ListIntegrations
84286-
responses:
84287-
'200':
84288-
content:
84289-
application/json:
84290-
schema:
84291-
$ref: '#/components/schemas/ListIntegrationsResponse'
84292-
description: Successful Response.
84293-
'429':
84294-
$ref: '#/components/responses/TooManyRequestsResponse'
84295-
security:
84296-
- apiKeyAuth: []
84297-
appKeyAuth: []
84298-
summary: List Integrations
84299-
tags:
84300-
- Integrations
8430184208
/api/v2/integrations/cloudflare/accounts:
8430284209
get:
8430384210
description: List Cloudflare accounts.
@@ -102003,7 +101910,7 @@ paths:
102003101910
appKeyAuth: []
102004101911
- AuthZ:
102005101912
- synthetics_write
102006-
summary: 'Synthetics: Create a test suite'
101913+
summary: Create a test suite
102007101914
tags:
102008101915
- Synthetics
102009101916
x-permission:
@@ -102040,7 +101947,7 @@ paths:
102040101947
appKeyAuth: []
102041101948
- AuthZ:
102042101949
- synthetics_write
102043-
summary: 'Synthetics: Bulk delete suites'
101950+
summary: Bulk delete suites
102044101951
tags:
102045101952
- Synthetics
102046101953
x-permission:
@@ -102049,7 +101956,7 @@ paths:
102049101956
- synthetics_write
102050101957
/api/v2/synthetics/suites/search:
102051101958
get:
102052-
description: Search for Synthetics suites.
101959+
description: Search for test suites.
102053101960
operationId: SearchSuites
102054101961
parameters:
102055101962
- description: The search query.
@@ -102108,7 +102015,7 @@ paths:
102108102015
appKeyAuth: []
102109102016
- AuthZ:
102110102017
- synthetics_read
102111-
summary: Search Synthetics suites
102018+
summary: Search test suites
102112102019
tags:
102113102020
- Synthetics
102114102021
x-permission:
@@ -102145,7 +102052,7 @@ paths:
102145102052
appKeyAuth: []
102146102053
- AuthZ:
102147102054
- synthetics_read
102148-
summary: 'Synthetics: Get a suite'
102055+
summary: Get a suite
102149102056
tags:
102150102057
- Synthetics
102151102058
x-permission:
@@ -102188,7 +102095,7 @@ paths:
102188102095
appKeyAuth: []
102189102096
- AuthZ:
102190102097
- synthetics_write
102191-
summary: 'Synthetics: Edit a test suite'
102098+
summary: Edit a test suite
102192102099
tags:
102193102100
- Synthetics
102194102101
x-permission:
@@ -102230,7 +102137,7 @@ paths:
102230102137
appKeyAuth: []
102231102138
- AuthZ:
102232102139
- synthetics_write
102233-
summary: 'Synthetics: Bulk delete tests'
102140+
summary: Bulk delete tests
102234102141
tags:
102235102142
- Synthetics
102236102143
x-permission:
@@ -102266,7 +102173,7 @@ paths:
102266102173
appKeyAuth: []
102267102174
- AuthZ:
102268102175
- synthetics_write
102269-
summary: 'Synthetics: Create a Network Path test'
102176+
summary: Create a Network Path test
102270102177
tags:
102271102178
- Synthetics
102272102179
x-permission:
@@ -102310,7 +102217,7 @@ paths:
102310102217
appKeyAuth: []
102311102218
- AuthZ:
102312102219
- synthetics_read
102313-
summary: 'Synthetics: Get a Network Path test'
102220+
summary: Get a Network Path test
102314102221
tags:
102315102222
- Synthetics
102316102223
x-permission:
@@ -102359,7 +102266,7 @@ paths:
102359102266
appKeyAuth: []
102360102267
- AuthZ:
102361102268
- synthetics_write
102362-
summary: 'Synthetics: Edit a Network Path test'
102269+
summary: Edit a Network Path test
102363102270
tags:
102364102271
- Synthetics
102365102272
x-permission:
@@ -106384,10 +106291,6 @@ tags:
106384106291
and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
106385106292
for more information.
106386106293
name: Incidents
106387-
- description: 'The Integrations API is used to list available integrations
106388-
106389-
and retrieve information about their installation status.'
106390-
name: Integrations
106391106294
- description: Manage your Jira Integration. Atlassian Jira is a project management
106392106295
and issue tracking tool for teams to coordinate work and handle tasks efficiently.
106393106296
name: Jira Integration

cassettes/v2/Integrations_3892031482/List-Integrations-returns-Successful-Response-response_1582902457/frozen.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

cassettes/v2/Integrations_3892031482/List-Integrations-returns-Successful-Response-response_1582902457/recording.har

Lines changed: 0 additions & 57 deletions
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2026-02-18T16:57:03.696Z"
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
{
2+
"log": {
3+
"_recordingName": "Synthetics/Create a Network Path test returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "3e9c7578282c3e74af19c5c1adf2db20",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 496,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
},
23+
{
24+
"_fromType": "array",
25+
"name": "content-type",
26+
"value": "application/json"
27+
}
28+
],
29+
"headersSize": 586,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "POST",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"data\":{\"attributes\":{\"config\":{\"assertions\":[{\"operator\":\"lessThan\",\"property\":\"avg\",\"target\":500,\"type\":\"latency\"}],\"request\":{\"e2e_queries\":50,\"host\":\"example.com\",\"max_ttl\":30,\"port\":443,\"tcp_method\":\"prefer_sack\",\"traceroute_queries\":3}},\"locations\":[\"aws:us-east-1\",\"agent:my-agent-name\"],\"message\":\"Network Path test notification\",\"name\":\"Example Network Path test\",\"options\":{\"tick_every\":60},\"status\":\"live\",\"subtype\":\"tcp\",\"tags\":[\"env:production\"],\"type\":\"network\"},\"type\":\"network\"}}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v2/synthetics/tests/network"
39+
},
40+
"response": {
41+
"bodySize": 547,
42+
"content": {
43+
"mimeType": "application/json",
44+
"size": 547,
45+
"text": "{\"data\":{\"type\":\"network_test\",\"attributes\":{\"config\":{\"request\":{\"max_ttl\":30,\"tcp_method\":\"prefer_sack\",\"host\":\"example.com\",\"e2e_queries\":50,\"traceroute_queries\":3,\"port\":443},\"assertions\":[{\"operator\":\"lessThan\",\"property\":\"avg\",\"target\":500,\"type\":\"latency\"}]},\"message\":\"Network Path test notification\",\"name\":\"Example Network Path test\",\"tags\":[\"env:production\"],\"options\":{\"tick_every\":60},\"type\":\"network\",\"public_id\":\"b2j-fw3-qr5\",\"subtype\":\"tcp\",\"locations\":[\"aws:us-east-1\",\"agent:my-agent-name\"],\"status\":\"live\"},\"id\":\"b2j-fw3-qr5\"}}\n"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/json"
52+
}
53+
],
54+
"headersSize": 693,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 200,
58+
"statusText": "OK"
59+
},
60+
"startedDateTime": "2026-02-18T16:57:03.698Z",
61+
"time": 467
62+
},
63+
{
64+
"_id": "55ca62e271971794385ff42131cef2d5",
65+
"_order": 0,
66+
"cache": {},
67+
"request": {
68+
"bodySize": 84,
69+
"cookies": [],
70+
"headers": [
71+
{
72+
"_fromType": "array",
73+
"name": "accept",
74+
"value": "application/json"
75+
},
76+
{
77+
"_fromType": "array",
78+
"name": "content-type",
79+
"value": "application/json"
80+
}
81+
],
82+
"headersSize": 583,
83+
"httpVersion": "HTTP/1.1",
84+
"method": "POST",
85+
"postData": {
86+
"mimeType": "application/json",
87+
"params": [],
88+
"text": "{\"data\":{\"attributes\":{\"public_ids\":[\"b2j-fw3-qr5\"]},\"type\":\"delete_tests_request\"}}"
89+
},
90+
"queryString": [],
91+
"url": "https://api.datadoghq.com/api/v2/synthetics/tests/bulk-delete"
92+
},
93+
"response": {
94+
"bodySize": 143,
95+
"content": {
96+
"mimeType": "application/json",
97+
"size": 143,
98+
"text": "{\"data\":[{\"type\":\"delete_tests\",\"attributes\":{\"deleted_at\":\"2026-02-18T16:57:04.752457+00:00\",\"public_id\":\"b2j-fw3-qr5\"},\"id\":\"b2j-fw3-qr5\"}]}\n"
99+
},
100+
"cookies": [],
101+
"headers": [
102+
{
103+
"name": "content-type",
104+
"value": "application/json"
105+
}
106+
],
107+
"headersSize": 694,
108+
"httpVersion": "HTTP/1.1",
109+
"redirectURL": "",
110+
"status": 200,
111+
"statusText": "OK"
112+
},
113+
"startedDateTime": "2026-02-18T16:57:04.171Z",
114+
"time": 944
115+
}
116+
],
117+
"pages": [],
118+
"version": "1.2"
119+
}
120+
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2026-02-18T16:57:05.121Z"

0 commit comments

Comments
 (0)