Skip to content

Commit 6947142

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
[chores] Clean up Synthetics API Reference menu sidebar (#34706)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 2dd9ba5 commit 6947142

File tree

9 files changed

+161
-261
lines changed

9 files changed

+161
-261
lines changed

‎config/_default/menus/api.en.yaml‎

Lines changed: 67 additions & 83 deletions
Large diffs are not rendered by default.

‎content/en/api/v1/synthetics/request.UpdateMobileTest_477498912.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name": "Example-Synthetic-updated",
3+
"status": "paused",
4+
"type": "mobile",
5+
"config": {
6+
"variables": []
7+
},
8+
"message": "",
9+
"options": {
10+
"device_ids": [
11+
"synthetics:mobile:device:iphone_15_ios_17"
12+
],
13+
"mobileApplication": {
14+
"applicationId": "ab0e0aed-536d-411a-9a99-5428c27d8f8e",
15+
"referenceId": "6115922a-5f5d-455e-bc7e-7955a57f3815",
16+
"referenceType": "version"
17+
},
18+
"tick_every": 3600
19+
},
20+
"steps": []
21+
}

‎data/api/v1/CodeExamples.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1034,7 +1034,7 @@
10341034
"UpdateMobileTest": [
10351035
{
10361036
"group": "synthetics",
1037-
"suffix": "",
1037+
"suffix": "_477498912",
10381038
"description": "Edit a Mobile test returns \"OK\" response"
10391039
}
10401040
],

‎data/api/v1/full_spec.yaml‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35559,7 +35559,7 @@ paths:
3555935559
summary: Get details of batch
3556035560
tags:
3556135561
- Synthetics
35562-
x-menu-order: 16
35562+
x-menu-order: 12
3556335563
x-permission:
3556435564
operator: OR
3556535565
permissions:
@@ -35587,7 +35587,7 @@ paths:
3558735587
summary: Get all locations (public and private)
3558835588
tags:
3558935589
- Synthetics
35590-
x-menu-order: 26
35590+
x-menu-order: 24
3559135591
x-permission:
3559235592
operator: OR
3559335593
permissions:
@@ -35710,7 +35710,7 @@ paths:
3571035710
summary: Get a private location
3571135711
tags:
3571235712
- Synthetics
35713-
x-menu-order: 24
35713+
x-menu-order: 25
3571435714
x-permission:
3571535715
operator: OR
3571635716
permissions:
@@ -35758,7 +35758,7 @@ paths:
3575835758
tags:
3575935759
- Synthetics
3576035760
x-codegen-request-body-name: body
35761-
x-menu-order: 25
35761+
x-menu-order: 26
3576235762
x-permission:
3576335763
operator: OR
3576435764
permissions:
@@ -35834,7 +35834,7 @@ paths:
3583435834
summary: Get the list of all Synthetic tests
3583535835
tags:
3583635836
- Synthetics
35837-
x-menu-order: 11
35837+
x-menu-order: 3
3583835838
x-pagination:
3583935839
limitParam: page_size
3584035840
pageParam: page_number
@@ -35894,7 +35894,7 @@ paths:
3589435894
tags:
3589535895
- Synthetics
3589635896
x-codegen-request-body-name: body
35897-
x-menu-order: 31
35897+
x-menu-order: 35
3589835898
x-permission:
3589935899
operator: OR
3590035900
permissions:
@@ -36116,7 +36116,7 @@ paths:
3611636116
summary: Get an API test
3611736117
tags:
3611836118
- Synthetics
36119-
x-menu-order: 9
36119+
x-menu-order: 6
3612036120
x-permission:
3612136121
operator: OR
3612236122
permissions:
@@ -36180,7 +36180,7 @@ paths:
3618036180
tags:
3618136181
- Synthetics
3618236182
x-codegen-request-body-name: body
36183-
x-menu-order: 3
36183+
x-menu-order: 16
3618436184
x-permission:
3618536185
operator: OR
3618636186
permissions:
@@ -36283,7 +36283,7 @@ paths:
3628336283
summary: Get a browser test
3628436284
tags:
3628536285
- Synthetics
36286-
x-menu-order: 10
36286+
x-menu-order: 6
3628736287
x-permission:
3628836288
operator: OR
3628936289
permissions:
@@ -36347,7 +36347,7 @@ paths:
3634736347
tags:
3634836348
- Synthetics
3634936349
x-codegen-request-body-name: body
36350-
x-menu-order: 4
36350+
x-menu-order: 16
3635136351
x-permission:
3635236352
operator: OR
3635336353
permissions:
@@ -36420,7 +36420,7 @@ paths:
3642036420
tags:
3642136421
- Synthetics
3642236422
x-codegen-request-body-name: body
36423-
x-menu-order: 15
36423+
x-menu-order: 10
3642436424
x-permission:
3642536425
operator: OR
3642636426
permissions:
@@ -36475,7 +36475,7 @@ paths:
3647536475
summary: Get a browser test result
3647636476
tags:
3647736477
- Synthetics
36478-
x-menu-order: 13
36478+
x-menu-order: 11
3647936479
x-permission:
3648036480
operator: OR
3648136481
permissions:
@@ -36597,7 +36597,7 @@ paths:
3659736597
get:
3659836598
description: 'Get the detailed configuration associated with
3659936599

36600-
a Synthetic Mobile test.'
36600+
a Synthetic mobile test.'
3660136601
operationId: GetMobileTest
3660236602
parameters:
3660336603
- description: The public ID of the test to get details from.
@@ -36634,16 +36634,16 @@ paths:
3663436634
appKeyAuth: []
3663536635
- AuthZ:
3663636636
- synthetics_read
36637-
summary: Get a Mobile test
36637+
summary: Get a mobile test
3663836638
tags:
3663936639
- Synthetics
36640-
x-menu-order: 9
36640+
x-menu-order: 7
3664136641
x-permission:
3664236642
operator: OR
3664336643
permissions:
3664436644
- synthetics_read
3664536645
put:
36646-
description: Edit the configuration of a Synthetic Mobile test.
36646+
description: Edit the configuration of a Synthetic mobile test.
3664736647
operationId: UpdateMobileTest
3664836648
parameters:
3664936649
- description: The public ID of the test to get details from.
@@ -36697,11 +36697,11 @@ paths:
3669736697
appKeyAuth: []
3669836698
- AuthZ:
3669936699
- synthetics_write
36700-
summary: Edit a Mobile test
36700+
summary: Edit a mobile test
3670136701
tags:
3670236702
- Synthetics
3670336703
x-codegen-request-body-name: body
36704-
x-menu-order: 3
36704+
x-menu-order: 16
3670536705
x-permission:
3670636706
operator: OR
3670736707
permissions:
@@ -36782,7 +36782,7 @@ paths:
3678236782
summary: Search Synthetic tests
3678336783
tags:
3678436784
- Synthetics
36785-
x-menu-order: 34
36785+
x-menu-order: 5
3678636786
x-permission:
3678736787
operator: OR
3678836788
permissions:
@@ -36822,7 +36822,7 @@ paths:
3682236822
tags:
3682336823
- Synthetics
3682436824
x-codegen-request-body-name: body
36825-
x-menu-order: 8
36825+
x-menu-order: 14
3682636826
x-permission:
3682736827
operator: OR
3682836828
permissions:
@@ -36862,7 +36862,7 @@ paths:
3686236862
tags:
3686336863
- Synthetics
3686436864
x-codegen-request-body-name: body
36865-
x-menu-order: 7
36865+
x-menu-order: 13
3686636866
x-permission:
3686736867
operator: OR
3686836868
permissions:
@@ -36910,7 +36910,7 @@ paths:
3691036910
tags:
3691136911
- Synthetics
3691236912
x-codegen-request-body-name: body
36913-
x-menu-order: 30
36913+
x-menu-order: 15
3691436914
x-permission:
3691536915
operator: OR
3691636916
permissions:
@@ -36957,7 +36957,7 @@ paths:
3695736957
summary: Get a test configuration
3695836958
tags:
3695936959
- Synthetics
36960-
x-menu-order: 28
36960+
x-menu-order: 4
3696136961
x-permission:
3696236962
operator: OR
3696336963
permissions:
@@ -37021,7 +37021,7 @@ paths:
3702137021
tags:
3702237022
- Synthetics
3702337023
x-codegen-request-body-name: body
37024-
x-menu-order: 5
37024+
x-menu-order: 16
3702537025
x-permission:
3702637026
operator: OR
3702737027
permissions:
@@ -37087,7 +37087,7 @@ paths:
3708737087
tags:
3708837088
- Synthetics
3708937089
x-codegen-request-body-name: body
37090-
x-menu-order: 30
37090+
x-menu-order: 36
3709137091
x-permission:
3709237092
operator: OR
3709337093
permissions:
@@ -37158,7 +37158,7 @@ paths:
3715837158
tags:
3715937159
- Synthetics
3716037160
x-codegen-request-body-name: body
37161-
x-menu-order: 14
37161+
x-menu-order: 8
3716237162
x-permission:
3716337163
operator: OR
3716437164
permissions:
@@ -37211,7 +37211,7 @@ paths:
3721137211
summary: Get an API test result
3721237212
tags:
3721337213
- Synthetics
37214-
x-menu-order: 12
37214+
x-menu-order: 9
3721537215
x-permission:
3721637216
operator: OR
3721737217
permissions:
@@ -37272,7 +37272,7 @@ paths:
3727237272
tags:
3727337273
- Synthetics
3727437274
x-codegen-request-body-name: body
37275-
x-menu-order: 6
37275+
x-menu-order: 16
3727637276
x-permission:
3727737277
operator: OR
3727837278
permissions:
@@ -37306,7 +37306,7 @@ paths:
3730637306
summary: Get all global variables
3730737307
tags:
3730837308
- Synthetics
37309-
x-menu-order: 18
37309+
x-menu-order: 19
3731037310
x-permission:
3731137311
operator: OR
3731237312
permissions:
@@ -37358,7 +37358,7 @@ paths:
3735837358
tags:
3735937359
- Synthetics
3736037360
x-codegen-request-body-name: body
37361-
x-menu-order: 19
37361+
x-menu-order: 18
3736237362
x-permission:
3736337363
operator: OR
3736437364
permissions:

‎data/api/v1/translate_actions.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -926,12 +926,12 @@
926926
"request_schema_description": "Object containing details about a Synthetic mobile test."
927927
},
928928
"GetMobileTest": {
929-
"description": "Get the detailed configuration associated with\na Synthetic Mobile test.",
930-
"summary": "Get a Mobile test"
929+
"description": "Get the detailed configuration associated with\na Synthetic mobile test.",
930+
"summary": "Get a mobile test"
931931
},
932932
"UpdateMobileTest": {
933-
"description": "Edit the configuration of a Synthetic Mobile test.",
934-
"summary": "Edit a Mobile test",
933+
"description": "Edit the configuration of a Synthetic mobile test.",
934+
"summary": "Edit a mobile test",
935935
"request_description": "New test details to be saved.",
936936
"request_schema_description": "Object containing details about a Synthetic mobile test."
937937
},

‎data/api/v2/CodeExamples.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2056,25 +2056,25 @@
20562056
"description": "Update status page returns \"OK\" response"
20572057
}
20582058
],
2059-
"SetOnDemandConcurrencyCap": [
2059+
"CreateSyntheticsNetworkTest": [
20602060
{
20612061
"group": "synthetics",
20622062
"suffix": "",
2063-
"description": "Save new value for on-demand concurrency cap returns \"OK\" response"
2063+
"description": "Create a Network Path test returns \"OK\" response"
20642064
}
20652065
],
2066-
"CreateSyntheticsNetworkTest": [
2066+
"CreateSyntheticsSuite": [
20672067
{
20682068
"group": "synthetics",
20692069
"suffix": "",
2070-
"description": "Synthetics: Create a Network Path test returns \"OK\" response"
2070+
"description": "Create a test suite returns \"OK\" response"
20712071
}
20722072
],
2073-
"CreateSyntheticsSuite": [
2073+
"SetOnDemandConcurrencyCap": [
20742074
{
20752075
"group": "synthetics",
20762076
"suffix": "",
2077-
"description": "Synthetics: Create a test suite returns \"OK\" response"
2077+
"description": "Save new value for on-demand concurrency cap returns \"OK\" response"
20782078
}
20792079
],
20802080
"AddTeamHierarchyLink": [

0 commit comments

Comments
 (0)