@browserstack/mcp-server 1.5.0-beta.11 → 1.5.0-beta.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/capability/loadtesting.capability-index.json +27 -5
- package/capability/tm.capability-index.json +313 -112
- package/dist/tools/capability-registry/bind.js +159 -5
- package/dist/tools/capability-registry/register.d.ts +6 -0
- package/dist/tools/capability-registry/register.js +144 -77
- package/dist/tools/capability-registry/search.d.ts +10 -4
- package/dist/tools/capability-registry/search.js +80 -22
- package/dist/tools/capability-registry/types.d.ts +42 -6
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schema_version": 1,
|
|
3
|
-
"version": "1.
|
|
4
|
-
"build_id": "
|
|
3
|
+
"version": "1.5",
|
|
4
|
+
"build_id": "bd02ae3b_2026-09-10T11:51:51Z",
|
|
5
5
|
"tm": {
|
|
6
6
|
"summary": "BrowserStack Test Management API (v1 — the SSO/OAuth app API, session-authenticated).",
|
|
7
7
|
"capabilities": [
|
|
@@ -21,7 +21,8 @@
|
|
|
21
21
|
"name": "test_run_id",
|
|
22
22
|
"type": "string",
|
|
23
23
|
"required": true,
|
|
24
|
-
"example": "TR-14"
|
|
24
|
+
"example": "TR-14",
|
|
25
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
25
26
|
}
|
|
26
27
|
],
|
|
27
28
|
"body": [
|
|
@@ -161,7 +162,8 @@
|
|
|
161
162
|
"name": "test_plan_ids",
|
|
162
163
|
"type": "array",
|
|
163
164
|
"required": true,
|
|
164
|
-
"description": "Plan INTEGER ids."
|
|
165
|
+
"description": "Plan INTEGER ids.",
|
|
166
|
+
"minItems": 1
|
|
165
167
|
}
|
|
166
168
|
],
|
|
167
169
|
"intent": "Archive test plans in bulk (reversible — prefer this over delete)",
|
|
@@ -209,13 +211,15 @@
|
|
|
209
211
|
"name": "test_run_id",
|
|
210
212
|
"type": "string",
|
|
211
213
|
"required": true,
|
|
212
|
-
"example": "TR-14"
|
|
214
|
+
"example": "TR-14",
|
|
215
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
213
216
|
}
|
|
214
217
|
],
|
|
215
218
|
"query": [
|
|
216
219
|
{
|
|
217
220
|
"name": "include_subfolders_tc",
|
|
218
|
-
"type": "boolean"
|
|
221
|
+
"type": "boolean",
|
|
222
|
+
"default": false
|
|
219
223
|
}
|
|
220
224
|
],
|
|
221
225
|
"body": [
|
|
@@ -504,7 +508,9 @@
|
|
|
504
508
|
"name": "result_ids",
|
|
505
509
|
"type": "array",
|
|
506
510
|
"required": true,
|
|
507
|
-
"description": "Result INTEGER ids. Non-empty, max 300."
|
|
511
|
+
"description": "Result INTEGER ids. Non-empty, max 300.",
|
|
512
|
+
"minItems": 1,
|
|
513
|
+
"maxItems": 300
|
|
508
514
|
}
|
|
509
515
|
],
|
|
510
516
|
"intent": "Delete test results in bulk — PARTIAL SUCCESS is normal, always read `skipped`",
|
|
@@ -739,13 +745,15 @@
|
|
|
739
745
|
"name": "test_run_id",
|
|
740
746
|
"type": "string",
|
|
741
747
|
"required": true,
|
|
742
|
-
"example": "TR-14"
|
|
748
|
+
"example": "TR-14",
|
|
749
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
743
750
|
}
|
|
744
751
|
],
|
|
745
752
|
"query": [
|
|
746
753
|
{
|
|
747
754
|
"name": "include_subfolders_tc",
|
|
748
|
-
"type": "boolean"
|
|
755
|
+
"type": "boolean",
|
|
756
|
+
"default": false
|
|
749
757
|
},
|
|
750
758
|
{
|
|
751
759
|
"name": "status_id",
|
|
@@ -917,7 +925,14 @@
|
|
|
917
925
|
{
|
|
918
926
|
"name": "operation",
|
|
919
927
|
"type": "string",
|
|
920
|
-
"required": true
|
|
928
|
+
"required": true,
|
|
929
|
+
"values": [
|
|
930
|
+
"add",
|
|
931
|
+
"remove",
|
|
932
|
+
"replace",
|
|
933
|
+
"empty",
|
|
934
|
+
"ignore"
|
|
935
|
+
]
|
|
921
936
|
},
|
|
922
937
|
{
|
|
923
938
|
"name": "value",
|
|
@@ -934,7 +949,14 @@
|
|
|
934
949
|
{
|
|
935
950
|
"name": "operation",
|
|
936
951
|
"type": "string",
|
|
937
|
-
"required": true
|
|
952
|
+
"required": true,
|
|
953
|
+
"values": [
|
|
954
|
+
"add",
|
|
955
|
+
"remove",
|
|
956
|
+
"replace",
|
|
957
|
+
"empty",
|
|
958
|
+
"ignore"
|
|
959
|
+
]
|
|
938
960
|
},
|
|
939
961
|
{
|
|
940
962
|
"name": "value",
|
|
@@ -957,7 +979,12 @@
|
|
|
957
979
|
{
|
|
958
980
|
"name": "operation",
|
|
959
981
|
"type": "string",
|
|
960
|
-
"required": true
|
|
982
|
+
"required": true,
|
|
983
|
+
"values": [
|
|
984
|
+
"replace",
|
|
985
|
+
"empty",
|
|
986
|
+
"ignore"
|
|
987
|
+
]
|
|
961
988
|
},
|
|
962
989
|
{
|
|
963
990
|
"name": "value",
|
|
@@ -973,7 +1000,12 @@
|
|
|
973
1000
|
{
|
|
974
1001
|
"name": "operation",
|
|
975
1002
|
"type": "string",
|
|
976
|
-
"required": true
|
|
1003
|
+
"required": true,
|
|
1004
|
+
"values": [
|
|
1005
|
+
"replace",
|
|
1006
|
+
"empty",
|
|
1007
|
+
"ignore"
|
|
1008
|
+
]
|
|
977
1009
|
},
|
|
978
1010
|
{
|
|
979
1011
|
"name": "value",
|
|
@@ -989,7 +1021,12 @@
|
|
|
989
1021
|
{
|
|
990
1022
|
"name": "operation",
|
|
991
1023
|
"type": "string",
|
|
992
|
-
"required": true
|
|
1024
|
+
"required": true,
|
|
1025
|
+
"values": [
|
|
1026
|
+
"replace",
|
|
1027
|
+
"empty",
|
|
1028
|
+
"ignore"
|
|
1029
|
+
]
|
|
993
1030
|
},
|
|
994
1031
|
{
|
|
995
1032
|
"name": "value",
|
|
@@ -1005,7 +1042,12 @@
|
|
|
1005
1042
|
{
|
|
1006
1043
|
"name": "operation",
|
|
1007
1044
|
"type": "string",
|
|
1008
|
-
"required": true
|
|
1045
|
+
"required": true,
|
|
1046
|
+
"values": [
|
|
1047
|
+
"replace",
|
|
1048
|
+
"empty",
|
|
1049
|
+
"ignore"
|
|
1050
|
+
]
|
|
1009
1051
|
},
|
|
1010
1052
|
{
|
|
1011
1053
|
"name": "value",
|
|
@@ -1022,7 +1064,12 @@
|
|
|
1022
1064
|
{
|
|
1023
1065
|
"name": "operation",
|
|
1024
1066
|
"type": "string",
|
|
1025
|
-
"required": true
|
|
1067
|
+
"required": true,
|
|
1068
|
+
"values": [
|
|
1069
|
+
"replace",
|
|
1070
|
+
"empty",
|
|
1071
|
+
"ignore"
|
|
1072
|
+
]
|
|
1026
1073
|
},
|
|
1027
1074
|
{
|
|
1028
1075
|
"name": "value",
|
|
@@ -1039,7 +1086,12 @@
|
|
|
1039
1086
|
{
|
|
1040
1087
|
"name": "operation",
|
|
1041
1088
|
"type": "string",
|
|
1042
|
-
"required": true
|
|
1089
|
+
"required": true,
|
|
1090
|
+
"values": [
|
|
1091
|
+
"replace",
|
|
1092
|
+
"empty",
|
|
1093
|
+
"ignore"
|
|
1094
|
+
]
|
|
1043
1095
|
},
|
|
1044
1096
|
{
|
|
1045
1097
|
"name": "value",
|
|
@@ -1056,7 +1108,12 @@
|
|
|
1056
1108
|
{
|
|
1057
1109
|
"name": "operation",
|
|
1058
1110
|
"type": "string",
|
|
1059
|
-
"required": true
|
|
1111
|
+
"required": true,
|
|
1112
|
+
"values": [
|
|
1113
|
+
"replace",
|
|
1114
|
+
"empty",
|
|
1115
|
+
"ignore"
|
|
1116
|
+
]
|
|
1060
1117
|
},
|
|
1061
1118
|
{
|
|
1062
1119
|
"name": "value",
|
|
@@ -1072,7 +1129,12 @@
|
|
|
1072
1129
|
{
|
|
1073
1130
|
"name": "operation",
|
|
1074
1131
|
"type": "string",
|
|
1075
|
-
"required": true
|
|
1132
|
+
"required": true,
|
|
1133
|
+
"values": [
|
|
1134
|
+
"replace",
|
|
1135
|
+
"empty",
|
|
1136
|
+
"ignore"
|
|
1137
|
+
]
|
|
1076
1138
|
},
|
|
1077
1139
|
{
|
|
1078
1140
|
"name": "value",
|
|
@@ -1089,7 +1151,14 @@
|
|
|
1089
1151
|
{
|
|
1090
1152
|
"name": "operation",
|
|
1091
1153
|
"type": "string",
|
|
1092
|
-
"required": true
|
|
1154
|
+
"required": true,
|
|
1155
|
+
"values": [
|
|
1156
|
+
"add",
|
|
1157
|
+
"remove",
|
|
1158
|
+
"replace",
|
|
1159
|
+
"empty",
|
|
1160
|
+
"ignore"
|
|
1161
|
+
]
|
|
1093
1162
|
},
|
|
1094
1163
|
{
|
|
1095
1164
|
"name": "value",
|
|
@@ -1359,7 +1428,8 @@
|
|
|
1359
1428
|
"name": "test_plan_ids",
|
|
1360
1429
|
"type": "array",
|
|
1361
1430
|
"required": true,
|
|
1362
|
-
"description": "Plan INTEGER ids."
|
|
1431
|
+
"description": "Plan INTEGER ids.",
|
|
1432
|
+
"minItems": 1
|
|
1363
1433
|
}
|
|
1364
1434
|
],
|
|
1365
1435
|
"intent": "Un-archive test plans in bulk (undo bulk-archive)",
|
|
@@ -1450,6 +1520,7 @@
|
|
|
1450
1520
|
{
|
|
1451
1521
|
"name": "copy_all_sub_plans",
|
|
1452
1522
|
"type": "boolean",
|
|
1523
|
+
"default": false,
|
|
1453
1524
|
"json_path": "/test_plan/copy_all_sub_plans"
|
|
1454
1525
|
},
|
|
1455
1526
|
{
|
|
@@ -1503,29 +1574,34 @@
|
|
|
1503
1574
|
"name": "test_run_id",
|
|
1504
1575
|
"type": "string",
|
|
1505
1576
|
"required": true,
|
|
1506
|
-
"example": "TR-14"
|
|
1577
|
+
"example": "TR-14",
|
|
1578
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
1507
1579
|
}
|
|
1508
1580
|
],
|
|
1509
1581
|
"body": [
|
|
1510
1582
|
{
|
|
1511
1583
|
"name": "copy_tc_assignee",
|
|
1512
1584
|
"type": "boolean",
|
|
1513
|
-
"description": "Copy test case assignees from the original run"
|
|
1585
|
+
"description": "Copy test case assignees from the original run",
|
|
1586
|
+
"default": false
|
|
1514
1587
|
},
|
|
1515
1588
|
{
|
|
1516
1589
|
"name": "copy_issues",
|
|
1517
1590
|
"type": "boolean",
|
|
1518
|
-
"description": "Copy issues linked to the original run"
|
|
1591
|
+
"description": "Copy issues linked to the original run",
|
|
1592
|
+
"default": false
|
|
1519
1593
|
},
|
|
1520
1594
|
{
|
|
1521
1595
|
"name": "copy_tags",
|
|
1522
1596
|
"type": "boolean",
|
|
1523
|
-
"description": "Copy tags from the original run"
|
|
1597
|
+
"description": "Copy tags from the original run",
|
|
1598
|
+
"default": false
|
|
1524
1599
|
},
|
|
1525
1600
|
{
|
|
1526
1601
|
"name": "copy_all_cases",
|
|
1527
1602
|
"type": "boolean",
|
|
1528
|
-
"description": "Include all test cases in the cloned run"
|
|
1603
|
+
"description": "Include all test cases in the cloned run",
|
|
1604
|
+
"default": false
|
|
1529
1605
|
},
|
|
1530
1606
|
{
|
|
1531
1607
|
"name": "status",
|
|
@@ -1651,7 +1727,8 @@
|
|
|
1651
1727
|
"name": "test_run_id",
|
|
1652
1728
|
"type": "string",
|
|
1653
1729
|
"required": true,
|
|
1654
|
-
"example": "TR-14"
|
|
1730
|
+
"example": "TR-14",
|
|
1731
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
1655
1732
|
}
|
|
1656
1733
|
],
|
|
1657
1734
|
"intent": "Close a test run",
|
|
@@ -1732,13 +1809,15 @@
|
|
|
1732
1809
|
"name": "async",
|
|
1733
1810
|
"type": "boolean",
|
|
1734
1811
|
"example": true,
|
|
1735
|
-
"description": "Whether to process asynchronously via background job"
|
|
1812
|
+
"description": "Whether to process asynchronously via background job",
|
|
1813
|
+
"default": true
|
|
1736
1814
|
},
|
|
1737
1815
|
{
|
|
1738
1816
|
"name": "copy_test_cases",
|
|
1739
1817
|
"type": "boolean",
|
|
1740
1818
|
"example": true,
|
|
1741
|
-
"description": "Whether to copy test cases within folder"
|
|
1819
|
+
"description": "Whether to copy test cases within folder",
|
|
1820
|
+
"default": true
|
|
1742
1821
|
}
|
|
1743
1822
|
],
|
|
1744
1823
|
"intent": "Copy a folder to another location",
|
|
@@ -2275,7 +2354,8 @@
|
|
|
2275
2354
|
{
|
|
2276
2355
|
"name": "field_name",
|
|
2277
2356
|
"type": "string",
|
|
2278
|
-
"required": true
|
|
2357
|
+
"required": true,
|
|
2358
|
+
"maxLength": 255
|
|
2279
2359
|
},
|
|
2280
2360
|
{
|
|
2281
2361
|
"name": "field_type",
|
|
@@ -2304,7 +2384,8 @@
|
|
|
2304
2384
|
"TestPlan",
|
|
2305
2385
|
"ExploratorySession"
|
|
2306
2386
|
],
|
|
2307
|
-
"description": "Which entity the field hangs off. One field belongs to exactly one."
|
|
2387
|
+
"description": "Which entity the field hangs off. One field belongs to exactly one.",
|
|
2388
|
+
"default": "TestCase"
|
|
2308
2389
|
},
|
|
2309
2390
|
{
|
|
2310
2391
|
"name": "is_required",
|
|
@@ -2338,7 +2419,8 @@
|
|
|
2338
2419
|
},
|
|
2339
2420
|
{
|
|
2340
2421
|
"name": "place_holder_text",
|
|
2341
|
-
"type": "string"
|
|
2422
|
+
"type": "string",
|
|
2423
|
+
"maxLength": 256
|
|
2342
2424
|
},
|
|
2343
2425
|
{
|
|
2344
2426
|
"name": "default_value",
|
|
@@ -2392,6 +2474,7 @@
|
|
|
2392
2474
|
"type": "string",
|
|
2393
2475
|
"required": true,
|
|
2394
2476
|
"description": "Name of the dataset.",
|
|
2477
|
+
"minLength": 1,
|
|
2395
2478
|
"json_path": "/dataset/name"
|
|
2396
2479
|
},
|
|
2397
2480
|
{
|
|
@@ -2403,13 +2486,16 @@
|
|
|
2403
2486
|
{
|
|
2404
2487
|
"name": "name",
|
|
2405
2488
|
"type": "string",
|
|
2406
|
-
"required": true
|
|
2489
|
+
"required": true,
|
|
2490
|
+
"pattern": "^[\\p{L}][\\p{L}\\p{N}_]*$"
|
|
2407
2491
|
},
|
|
2408
2492
|
{
|
|
2409
2493
|
"name": "uuid",
|
|
2410
2494
|
"type": "string"
|
|
2411
2495
|
}
|
|
2412
2496
|
],
|
|
2497
|
+
"minItems": 1,
|
|
2498
|
+
"maxItems": 40,
|
|
2413
2499
|
"json_path": "/dataset/variables"
|
|
2414
2500
|
},
|
|
2415
2501
|
{
|
|
@@ -2426,13 +2512,16 @@
|
|
|
2426
2512
|
{
|
|
2427
2513
|
"name": "row_data",
|
|
2428
2514
|
"type": "array",
|
|
2429
|
-
"required": true
|
|
2515
|
+
"required": true,
|
|
2516
|
+
"minItems": 1
|
|
2430
2517
|
},
|
|
2431
2518
|
{
|
|
2432
2519
|
"name": "uuid",
|
|
2433
2520
|
"type": "string"
|
|
2434
2521
|
}
|
|
2435
2522
|
],
|
|
2523
|
+
"minItems": 1,
|
|
2524
|
+
"maxItems": 100,
|
|
2436
2525
|
"json_path": "/dataset/rows"
|
|
2437
2526
|
}
|
|
2438
2527
|
],
|
|
@@ -2521,6 +2610,8 @@
|
|
|
2521
2610
|
"type": "integer",
|
|
2522
2611
|
"example": 60,
|
|
2523
2612
|
"description": "Planned duration in minutes.",
|
|
2613
|
+
"minimum": 0,
|
|
2614
|
+
"maximum": 2147483647,
|
|
2524
2615
|
"json_path": "/exploratory_session/timebox_duration"
|
|
2525
2616
|
},
|
|
2526
2617
|
{
|
|
@@ -2776,7 +2867,8 @@
|
|
|
2776
2867
|
"name": "name",
|
|
2777
2868
|
"type": "string",
|
|
2778
2869
|
"required": true,
|
|
2779
|
-
"description": "Name of the filter"
|
|
2870
|
+
"description": "Name of the filter",
|
|
2871
|
+
"minLength": 1
|
|
2780
2872
|
},
|
|
2781
2873
|
{
|
|
2782
2874
|
"name": "entity",
|
|
@@ -3274,7 +3366,8 @@
|
|
|
3274
3366
|
{
|
|
3275
3367
|
"name": "order",
|
|
3276
3368
|
"type": "integer",
|
|
3277
|
-
"required": true
|
|
3369
|
+
"required": true,
|
|
3370
|
+
"minimum": 1
|
|
3278
3371
|
},
|
|
3279
3372
|
{
|
|
3280
3373
|
"name": "step",
|
|
@@ -3719,12 +3812,14 @@
|
|
|
3719
3812
|
"name": "start_date",
|
|
3720
3813
|
"type": "string",
|
|
3721
3814
|
"description": "ISO-8601 date.",
|
|
3815
|
+
"format": "date",
|
|
3722
3816
|
"json_path": "/test_plan/start_date"
|
|
3723
3817
|
},
|
|
3724
3818
|
{
|
|
3725
3819
|
"name": "end_date",
|
|
3726
3820
|
"type": "string",
|
|
3727
3821
|
"description": "ISO-8601 date.",
|
|
3822
|
+
"format": "date",
|
|
3728
3823
|
"json_path": "/test_plan/end_date"
|
|
3729
3824
|
},
|
|
3730
3825
|
{
|
|
@@ -3838,7 +3933,8 @@
|
|
|
3838
3933
|
"name": "test_run_id",
|
|
3839
3934
|
"type": "string",
|
|
3840
3935
|
"required": true,
|
|
3841
|
-
"example": "TR-14"
|
|
3936
|
+
"example": "TR-14",
|
|
3937
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
3842
3938
|
},
|
|
3843
3939
|
{
|
|
3844
3940
|
"name": "test_case_id",
|
|
@@ -4884,7 +4980,8 @@
|
|
|
4884
4980
|
"name": "test_run_id",
|
|
4885
4981
|
"type": "string",
|
|
4886
4982
|
"required": true,
|
|
4887
|
-
"example": "TR-14"
|
|
4983
|
+
"example": "TR-14",
|
|
4984
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
4888
4985
|
}
|
|
4889
4986
|
],
|
|
4890
4987
|
"intent": "delete test run",
|
|
@@ -5560,7 +5657,8 @@
|
|
|
5560
5657
|
"name": "test_run_id",
|
|
5561
5658
|
"type": "string",
|
|
5562
5659
|
"required": true,
|
|
5563
|
-
"example": "TR-14"
|
|
5660
|
+
"example": "TR-14",
|
|
5661
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
5564
5662
|
}
|
|
5565
5663
|
],
|
|
5566
5664
|
"body": [
|
|
@@ -5811,12 +5909,14 @@
|
|
|
5811
5909
|
"name": "start_date",
|
|
5812
5910
|
"type": "string",
|
|
5813
5911
|
"example": "2025-01-01",
|
|
5912
|
+
"format": "date",
|
|
5814
5913
|
"json_path": "/filters/start_date"
|
|
5815
5914
|
},
|
|
5816
5915
|
{
|
|
5817
5916
|
"name": "end_date",
|
|
5818
5917
|
"type": "string",
|
|
5819
5918
|
"example": "2025-12-31",
|
|
5919
|
+
"format": "date",
|
|
5820
5920
|
"json_path": "/filters/end_date"
|
|
5821
5921
|
},
|
|
5822
5922
|
{
|
|
@@ -6418,7 +6518,8 @@
|
|
|
6418
6518
|
"query": [
|
|
6419
6519
|
{
|
|
6420
6520
|
"name": "p",
|
|
6421
|
-
"type": "integer"
|
|
6521
|
+
"type": "integer",
|
|
6522
|
+
"default": 1
|
|
6422
6523
|
}
|
|
6423
6524
|
],
|
|
6424
6525
|
"intent": "Get test cases linked to a dataset",
|
|
@@ -6487,7 +6588,8 @@
|
|
|
6487
6588
|
},
|
|
6488
6589
|
{
|
|
6489
6590
|
"name": "p",
|
|
6490
|
-
"type": "integer"
|
|
6591
|
+
"type": "integer",
|
|
6592
|
+
"default": 1
|
|
6491
6593
|
}
|
|
6492
6594
|
],
|
|
6493
6595
|
"intent": "Get dataset variables/columns.",
|
|
@@ -7031,15 +7133,18 @@
|
|
|
7031
7133
|
"values": [
|
|
7032
7134
|
"time_period",
|
|
7033
7135
|
"session_selection"
|
|
7034
|
-
]
|
|
7136
|
+
],
|
|
7137
|
+
"default": "time_period"
|
|
7035
7138
|
},
|
|
7036
7139
|
{
|
|
7037
7140
|
"name": "start_date",
|
|
7038
|
-
"type": "string"
|
|
7141
|
+
"type": "string",
|
|
7142
|
+
"format": "date"
|
|
7039
7143
|
},
|
|
7040
7144
|
{
|
|
7041
7145
|
"name": "end_date",
|
|
7042
|
-
"type": "string"
|
|
7146
|
+
"type": "string",
|
|
7147
|
+
"format": "date"
|
|
7043
7148
|
},
|
|
7044
7149
|
{
|
|
7045
7150
|
"name": "session_ids",
|
|
@@ -7419,7 +7524,7 @@
|
|
|
7419
7524
|
},
|
|
7420
7525
|
"info": {
|
|
7421
7526
|
"type": "object",
|
|
7422
|
-
"description": "Pagination/meta info passthrough from the
|
|
7527
|
+
"description": "Pagination/meta info passthrough from the backing service"
|
|
7423
7528
|
},
|
|
7424
7529
|
"meta_data": {
|
|
7425
7530
|
"type": "object",
|
|
@@ -7507,16 +7612,19 @@
|
|
|
7507
7612
|
"query": [
|
|
7508
7613
|
{
|
|
7509
7614
|
"name": "p",
|
|
7510
|
-
"type": "integer"
|
|
7615
|
+
"type": "integer",
|
|
7616
|
+
"minimum": 1,
|
|
7617
|
+
"default": 1
|
|
7511
7618
|
},
|
|
7512
7619
|
{
|
|
7513
7620
|
"name": "count",
|
|
7514
|
-
"type": "integer"
|
|
7621
|
+
"type": "integer",
|
|
7622
|
+
"minimum": 1
|
|
7515
7623
|
},
|
|
7516
7624
|
{
|
|
7517
7625
|
"name": "q[query]",
|
|
7518
7626
|
"type": "string",
|
|
7519
|
-
"example": "
|
|
7627
|
+
"example": "jdoe"
|
|
7520
7628
|
},
|
|
7521
7629
|
{
|
|
7522
7630
|
"name": "q[identifier]",
|
|
@@ -7563,11 +7671,14 @@
|
|
|
7563
7671
|
"query": [
|
|
7564
7672
|
{
|
|
7565
7673
|
"name": "p",
|
|
7566
|
-
"type": "integer"
|
|
7674
|
+
"type": "integer",
|
|
7675
|
+
"minimum": 1,
|
|
7676
|
+
"default": 1
|
|
7567
7677
|
},
|
|
7568
7678
|
{
|
|
7569
7679
|
"name": "count",
|
|
7570
|
-
"type": "integer"
|
|
7680
|
+
"type": "integer",
|
|
7681
|
+
"minimum": 1
|
|
7571
7682
|
}
|
|
7572
7683
|
],
|
|
7573
7684
|
"intent": "Get all projects (minified dropdown) — has NO name search",
|
|
@@ -7691,12 +7802,14 @@
|
|
|
7691
7802
|
},
|
|
7692
7803
|
{
|
|
7693
7804
|
"name": "p",
|
|
7694
|
-
"type": "integer"
|
|
7805
|
+
"type": "integer",
|
|
7806
|
+
"default": 1
|
|
7695
7807
|
},
|
|
7696
7808
|
{
|
|
7697
7809
|
"name": "today",
|
|
7698
7810
|
"type": "string",
|
|
7699
|
-
"example": "2025-05-13"
|
|
7811
|
+
"example": "2025-05-13",
|
|
7812
|
+
"format": "date"
|
|
7700
7813
|
}
|
|
7701
7814
|
],
|
|
7702
7815
|
"intent": "Retrieve a scheduled report's config and data — the general report read",
|
|
@@ -7771,7 +7884,8 @@
|
|
|
7771
7884
|
},
|
|
7772
7885
|
{
|
|
7773
7886
|
"name": "p",
|
|
7774
|
-
"type": "integer"
|
|
7887
|
+
"type": "integer",
|
|
7888
|
+
"default": 1
|
|
7775
7889
|
}
|
|
7776
7890
|
],
|
|
7777
7891
|
"intent": "Fetch one report widget/section — works for EVERY report type.",
|
|
@@ -7867,7 +7981,8 @@
|
|
|
7867
7981
|
},
|
|
7868
7982
|
{
|
|
7869
7983
|
"name": "p",
|
|
7870
|
-
"type": "integer"
|
|
7984
|
+
"type": "integer",
|
|
7985
|
+
"default": 1
|
|
7871
7986
|
}
|
|
7872
7987
|
],
|
|
7873
7988
|
"intent": "Get summary statistics for a scheduled report — run and traceability types ONLY",
|
|
@@ -7917,7 +8032,8 @@
|
|
|
7917
8032
|
{
|
|
7918
8033
|
"name": "include_folder_hierarchy",
|
|
7919
8034
|
"type": "boolean",
|
|
7920
|
-
"description": "Whether to include folder hierarchy in the response"
|
|
8035
|
+
"description": "Whether to include folder hierarchy in the response",
|
|
8036
|
+
"default": false
|
|
7921
8037
|
},
|
|
7922
8038
|
{
|
|
7923
8039
|
"name": "p",
|
|
@@ -8018,11 +8134,13 @@
|
|
|
8018
8134
|
"query": [
|
|
8019
8135
|
{
|
|
8020
8136
|
"name": "paginated",
|
|
8021
|
-
"type": "boolean"
|
|
8137
|
+
"type": "boolean",
|
|
8138
|
+
"default": false
|
|
8022
8139
|
},
|
|
8023
8140
|
{
|
|
8024
8141
|
"name": "p",
|
|
8025
|
-
"type": "integer"
|
|
8142
|
+
"type": "integer",
|
|
8143
|
+
"default": 1
|
|
8026
8144
|
}
|
|
8027
8145
|
],
|
|
8028
8146
|
"intent": "Get shared steps",
|
|
@@ -8071,7 +8189,8 @@
|
|
|
8071
8189
|
"query": [
|
|
8072
8190
|
{
|
|
8073
8191
|
"name": "p",
|
|
8074
|
-
"type": "integer"
|
|
8192
|
+
"type": "integer",
|
|
8193
|
+
"default": 1
|
|
8075
8194
|
},
|
|
8076
8195
|
{
|
|
8077
8196
|
"name": "q[query]",
|
|
@@ -8079,7 +8198,8 @@
|
|
|
8079
8198
|
},
|
|
8080
8199
|
{
|
|
8081
8200
|
"name": "pre_fetch",
|
|
8082
|
-
"type": "boolean"
|
|
8201
|
+
"type": "boolean",
|
|
8202
|
+
"default": false
|
|
8083
8203
|
}
|
|
8084
8204
|
],
|
|
8085
8205
|
"intent": "Get all shared steps for a project",
|
|
@@ -8475,7 +8595,9 @@
|
|
|
8475
8595
|
{
|
|
8476
8596
|
"name": "versions[]",
|
|
8477
8597
|
"type": "array",
|
|
8478
|
-
"required": true
|
|
8598
|
+
"required": true,
|
|
8599
|
+
"minItems": 2,
|
|
8600
|
+
"maxItems": 2
|
|
8479
8601
|
}
|
|
8480
8602
|
],
|
|
8481
8603
|
"intent": "Get test case history diff",
|
|
@@ -8709,7 +8831,8 @@
|
|
|
8709
8831
|
"name": "test_run_id",
|
|
8710
8832
|
"type": "string",
|
|
8711
8833
|
"required": true,
|
|
8712
|
-
"example": "TR-14"
|
|
8834
|
+
"example": "TR-14",
|
|
8835
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
8713
8836
|
}
|
|
8714
8837
|
],
|
|
8715
8838
|
"query": [
|
|
@@ -8760,7 +8883,9 @@
|
|
|
8760
8883
|
"query": [
|
|
8761
8884
|
{
|
|
8762
8885
|
"name": "p",
|
|
8763
|
-
"type": "integer"
|
|
8886
|
+
"type": "integer",
|
|
8887
|
+
"minimum": 1,
|
|
8888
|
+
"default": 1
|
|
8764
8889
|
},
|
|
8765
8890
|
{
|
|
8766
8891
|
"name": "per_page",
|
|
@@ -8891,7 +9016,8 @@
|
|
|
8891
9016
|
},
|
|
8892
9017
|
{
|
|
8893
9018
|
"name": "today",
|
|
8894
|
-
"type": "string"
|
|
9019
|
+
"type": "string",
|
|
9020
|
+
"format": "date"
|
|
8895
9021
|
}
|
|
8896
9022
|
],
|
|
8897
9023
|
"intent": "Execution-trend chart data for ONE plan or ONE run (XOR)",
|
|
@@ -8992,7 +9118,9 @@
|
|
|
8992
9118
|
"query": [
|
|
8993
9119
|
{
|
|
8994
9120
|
"name": "p",
|
|
8995
|
-
"type": "integer"
|
|
9121
|
+
"type": "integer",
|
|
9122
|
+
"minimum": 1,
|
|
9123
|
+
"default": 1
|
|
8996
9124
|
},
|
|
8997
9125
|
{
|
|
8998
9126
|
"name": "include_sub_test_plan_runs",
|
|
@@ -9050,7 +9178,9 @@
|
|
|
9050
9178
|
"query": [
|
|
9051
9179
|
{
|
|
9052
9180
|
"name": "p",
|
|
9053
|
-
"type": "integer"
|
|
9181
|
+
"type": "integer",
|
|
9182
|
+
"minimum": 1,
|
|
9183
|
+
"default": 1
|
|
9054
9184
|
},
|
|
9055
9185
|
{
|
|
9056
9186
|
"name": "per_page",
|
|
@@ -9110,7 +9240,8 @@
|
|
|
9110
9240
|
"name": "test_run_id",
|
|
9111
9241
|
"type": "string",
|
|
9112
9242
|
"required": true,
|
|
9113
|
-
"example": "TR-14"
|
|
9243
|
+
"example": "TR-14",
|
|
9244
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
9114
9245
|
},
|
|
9115
9246
|
{
|
|
9116
9247
|
"name": "test_case_id",
|
|
@@ -9377,11 +9508,13 @@
|
|
|
9377
9508
|
"query": [
|
|
9378
9509
|
{
|
|
9379
9510
|
"name": "ignore_run_type",
|
|
9380
|
-
"type": "boolean"
|
|
9511
|
+
"type": "boolean",
|
|
9512
|
+
"default": false
|
|
9381
9513
|
},
|
|
9382
9514
|
{
|
|
9383
9515
|
"name": "include_test_plan",
|
|
9384
|
-
"type": "boolean"
|
|
9516
|
+
"type": "boolean",
|
|
9517
|
+
"default": false
|
|
9385
9518
|
}
|
|
9386
9519
|
],
|
|
9387
9520
|
"intent": "Get all the test runs for a project",
|
|
@@ -9593,7 +9726,9 @@
|
|
|
9593
9726
|
"query": [
|
|
9594
9727
|
{
|
|
9595
9728
|
"name": "p",
|
|
9596
|
-
"type": "integer"
|
|
9729
|
+
"type": "integer",
|
|
9730
|
+
"minimum": 1,
|
|
9731
|
+
"default": 1
|
|
9597
9732
|
}
|
|
9598
9733
|
],
|
|
9599
9734
|
"intent": "List archived test plans",
|
|
@@ -9685,7 +9820,8 @@
|
|
|
9685
9820
|
},
|
|
9686
9821
|
{
|
|
9687
9822
|
"name": "p",
|
|
9688
|
-
"type": "integer"
|
|
9823
|
+
"type": "integer",
|
|
9824
|
+
"default": 1
|
|
9689
9825
|
}
|
|
9690
9826
|
],
|
|
9691
9827
|
"intent": "List datasets for a project.",
|
|
@@ -9751,7 +9887,8 @@
|
|
|
9751
9887
|
"query": [
|
|
9752
9888
|
{
|
|
9753
9889
|
"name": "page",
|
|
9754
|
-
"type": "integer"
|
|
9890
|
+
"type": "integer",
|
|
9891
|
+
"default": 1
|
|
9755
9892
|
},
|
|
9756
9893
|
{
|
|
9757
9894
|
"name": "entity_type",
|
|
@@ -9810,12 +9947,14 @@
|
|
|
9810
9947
|
{
|
|
9811
9948
|
"name": "page",
|
|
9812
9949
|
"type": "integer",
|
|
9813
|
-
"example": 1
|
|
9950
|
+
"example": 1,
|
|
9951
|
+
"default": 1
|
|
9814
9952
|
},
|
|
9815
9953
|
{
|
|
9816
9954
|
"name": "per_page",
|
|
9817
9955
|
"type": "integer",
|
|
9818
|
-
"example": 30
|
|
9956
|
+
"example": 30,
|
|
9957
|
+
"default": 30
|
|
9819
9958
|
}
|
|
9820
9959
|
],
|
|
9821
9960
|
"intent": "List defects for an exploratory session",
|
|
@@ -9905,12 +10044,14 @@
|
|
|
9905
10044
|
{
|
|
9906
10045
|
"name": "page",
|
|
9907
10046
|
"type": "integer",
|
|
9908
|
-
"example": 1
|
|
10047
|
+
"example": 1,
|
|
10048
|
+
"default": 1
|
|
9909
10049
|
},
|
|
9910
10050
|
{
|
|
9911
10051
|
"name": "per_page",
|
|
9912
10052
|
"type": "integer",
|
|
9913
|
-
"example": 50
|
|
10053
|
+
"example": 50,
|
|
10054
|
+
"default": 50
|
|
9914
10055
|
}
|
|
9915
10056
|
],
|
|
9916
10057
|
"intent": "List logs for an exploratory session",
|
|
@@ -9966,12 +10107,14 @@
|
|
|
9966
10107
|
{
|
|
9967
10108
|
"name": "page",
|
|
9968
10109
|
"type": "integer",
|
|
9969
|
-
"example": 1
|
|
10110
|
+
"example": 1,
|
|
10111
|
+
"default": 1
|
|
9970
10112
|
},
|
|
9971
10113
|
{
|
|
9972
10114
|
"name": "per_page",
|
|
9973
10115
|
"type": "integer",
|
|
9974
|
-
"example": 30
|
|
10116
|
+
"example": 30,
|
|
10117
|
+
"default": 30
|
|
9975
10118
|
},
|
|
9976
10119
|
{
|
|
9977
10120
|
"name": "q[session_state]",
|
|
@@ -9980,7 +10123,8 @@
|
|
|
9980
10123
|
"active",
|
|
9981
10124
|
"closed"
|
|
9982
10125
|
],
|
|
9983
|
-
"example": "active"
|
|
10126
|
+
"example": "active",
|
|
10127
|
+
"default": "active"
|
|
9984
10128
|
},
|
|
9985
10129
|
{
|
|
9986
10130
|
"name": "q[assignee]",
|
|
@@ -10000,12 +10144,14 @@
|
|
|
10000
10144
|
{
|
|
10001
10145
|
"name": "q[created_at_from]",
|
|
10002
10146
|
"type": "string",
|
|
10003
|
-
"example": "2026-01-01"
|
|
10147
|
+
"example": "2026-01-01",
|
|
10148
|
+
"format": "date"
|
|
10004
10149
|
},
|
|
10005
10150
|
{
|
|
10006
10151
|
"name": "q[created_at_to]",
|
|
10007
10152
|
"type": "string",
|
|
10008
|
-
"example": "2026-01-31"
|
|
10153
|
+
"example": "2026-01-31",
|
|
10154
|
+
"format": "date"
|
|
10009
10155
|
},
|
|
10010
10156
|
{
|
|
10011
10157
|
"name": "q[tags][]",
|
|
@@ -10103,7 +10249,9 @@
|
|
|
10103
10249
|
},
|
|
10104
10250
|
{
|
|
10105
10251
|
"name": "page",
|
|
10106
|
-
"type": "integer"
|
|
10252
|
+
"type": "integer",
|
|
10253
|
+
"minimum": 1,
|
|
10254
|
+
"default": 1
|
|
10107
10255
|
}
|
|
10108
10256
|
],
|
|
10109
10257
|
"intent": "List filters",
|
|
@@ -10204,7 +10352,9 @@
|
|
|
10204
10352
|
"query": [
|
|
10205
10353
|
{
|
|
10206
10354
|
"name": "p",
|
|
10207
|
-
"type": "integer"
|
|
10355
|
+
"type": "integer",
|
|
10356
|
+
"minimum": 1,
|
|
10357
|
+
"default": 1
|
|
10208
10358
|
},
|
|
10209
10359
|
{
|
|
10210
10360
|
"name": "per_page",
|
|
@@ -10259,11 +10409,13 @@
|
|
|
10259
10409
|
{
|
|
10260
10410
|
"name": "q",
|
|
10261
10411
|
"type": "string",
|
|
10262
|
-
"example": "
|
|
10412
|
+
"example": "jdoe"
|
|
10263
10413
|
},
|
|
10264
10414
|
{
|
|
10265
10415
|
"name": "p",
|
|
10266
|
-
"type": "integer"
|
|
10416
|
+
"type": "integer",
|
|
10417
|
+
"minimum": 1,
|
|
10418
|
+
"default": 1
|
|
10267
10419
|
},
|
|
10268
10420
|
{
|
|
10269
10421
|
"name": "sort_by",
|
|
@@ -10280,7 +10432,8 @@
|
|
|
10280
10432
|
{
|
|
10281
10433
|
"name": "is_hidden_projects",
|
|
10282
10434
|
"type": "boolean",
|
|
10283
|
-
"example": true
|
|
10435
|
+
"example": true,
|
|
10436
|
+
"default": false
|
|
10284
10437
|
}
|
|
10285
10438
|
],
|
|
10286
10439
|
"intent": "List projects for a group.",
|
|
@@ -10351,7 +10504,8 @@
|
|
|
10351
10504
|
},
|
|
10352
10505
|
{
|
|
10353
10506
|
"name": "p",
|
|
10354
|
-
"type": "integer"
|
|
10507
|
+
"type": "integer",
|
|
10508
|
+
"minimum": 1
|
|
10355
10509
|
}
|
|
10356
10510
|
],
|
|
10357
10511
|
"intent": "List all the scheduled reports",
|
|
@@ -10450,7 +10604,8 @@
|
|
|
10450
10604
|
"TestResult",
|
|
10451
10605
|
"TestPlan",
|
|
10452
10606
|
"ExploratorySession"
|
|
10453
|
-
]
|
|
10607
|
+
],
|
|
10608
|
+
"default": "TestCase"
|
|
10454
10609
|
},
|
|
10455
10610
|
{
|
|
10456
10611
|
"name": "project",
|
|
@@ -10505,11 +10660,14 @@
|
|
|
10505
10660
|
"query": [
|
|
10506
10661
|
{
|
|
10507
10662
|
"name": "p",
|
|
10508
|
-
"type": "integer"
|
|
10663
|
+
"type": "integer",
|
|
10664
|
+
"minimum": 1,
|
|
10665
|
+
"default": 1
|
|
10509
10666
|
},
|
|
10510
10667
|
{
|
|
10511
10668
|
"name": "include_sub_plans",
|
|
10512
|
-
"type": "boolean"
|
|
10669
|
+
"type": "boolean",
|
|
10670
|
+
"default": false
|
|
10513
10671
|
},
|
|
10514
10672
|
{
|
|
10515
10673
|
"name": "status",
|
|
@@ -10574,7 +10732,8 @@
|
|
|
10574
10732
|
"TestResult",
|
|
10575
10733
|
"TestPlan",
|
|
10576
10734
|
"ExploratorySession"
|
|
10577
|
-
]
|
|
10735
|
+
],
|
|
10736
|
+
"default": "TestCase"
|
|
10578
10737
|
},
|
|
10579
10738
|
{
|
|
10580
10739
|
"name": "field_source",
|
|
@@ -10583,7 +10742,8 @@
|
|
|
10583
10742
|
"system",
|
|
10584
10743
|
"custom",
|
|
10585
10744
|
"all"
|
|
10586
|
-
]
|
|
10745
|
+
],
|
|
10746
|
+
"default": "all"
|
|
10587
10747
|
},
|
|
10588
10748
|
{
|
|
10589
10749
|
"name": "field_type",
|
|
@@ -11228,7 +11388,9 @@
|
|
|
11228
11388
|
},
|
|
11229
11389
|
{
|
|
11230
11390
|
"name": "p",
|
|
11231
|
-
"type": "integer"
|
|
11391
|
+
"type": "integer",
|
|
11392
|
+
"minimum": 1,
|
|
11393
|
+
"default": 1
|
|
11232
11394
|
}
|
|
11233
11395
|
],
|
|
11234
11396
|
"intent": "Search group tags for an entity type",
|
|
@@ -11298,15 +11460,21 @@
|
|
|
11298
11460
|
},
|
|
11299
11461
|
{
|
|
11300
11462
|
"name": "p",
|
|
11301
|
-
"type": "integer"
|
|
11463
|
+
"type": "integer",
|
|
11464
|
+
"minimum": 1,
|
|
11465
|
+
"default": 1
|
|
11302
11466
|
},
|
|
11303
11467
|
{
|
|
11304
11468
|
"name": "page_size",
|
|
11305
|
-
"type": "integer"
|
|
11469
|
+
"type": "integer",
|
|
11470
|
+
"minimum": 1,
|
|
11471
|
+
"maximum": 100,
|
|
11472
|
+
"default": 30
|
|
11306
11473
|
},
|
|
11307
11474
|
{
|
|
11308
11475
|
"name": "include_test_plan",
|
|
11309
|
-
"type": "boolean"
|
|
11476
|
+
"type": "boolean",
|
|
11477
|
+
"default": false
|
|
11310
11478
|
}
|
|
11311
11479
|
],
|
|
11312
11480
|
"intent": "Search for entities within a project",
|
|
@@ -11553,13 +11721,18 @@
|
|
|
11553
11721
|
"name": "p",
|
|
11554
11722
|
"type": "integer",
|
|
11555
11723
|
"example": 1,
|
|
11556
|
-
"description": "Page number"
|
|
11724
|
+
"description": "Page number",
|
|
11725
|
+
"minimum": 1,
|
|
11726
|
+
"default": 1
|
|
11557
11727
|
},
|
|
11558
11728
|
{
|
|
11559
11729
|
"name": "per_page",
|
|
11560
11730
|
"type": "integer",
|
|
11561
11731
|
"example": 5,
|
|
11562
|
-
"description": "Results per page. Rows are large and vary with the data, so probe rather than assume: send p=1 with a moderate per_page and take the rows that actually come back as your ceiling (for entity=test-cases a row is ~40 keys / 5-9 KB, so start around 5). Then keep per_page FIXED for the whole walk — the offset is (p-1)*per_page, so changing it part-way shifts the window and SKIPS rows (page 1 at 5 then "
|
|
11732
|
+
"description": "Results per page. Rows are large and vary with the data, so probe rather than assume: send p=1 with a moderate per_page and take the rows that actually come back as your ceiling (for entity=test-cases a row is ~40 keys / 5-9 KB, so start around 5). Then keep per_page FIXED for the whole walk — the offset is (p-1)*per_page, so changing it part-way shifts the window and SKIPS rows (page 1 at 5 then ",
|
|
11733
|
+
"minimum": 1,
|
|
11734
|
+
"maximum": 100,
|
|
11735
|
+
"default": 25
|
|
11563
11736
|
},
|
|
11564
11737
|
{
|
|
11565
11738
|
"name": "fields",
|
|
@@ -11638,11 +11811,16 @@
|
|
|
11638
11811
|
},
|
|
11639
11812
|
{
|
|
11640
11813
|
"name": "p",
|
|
11641
|
-
"type": "integer"
|
|
11814
|
+
"type": "integer",
|
|
11815
|
+
"minimum": 1,
|
|
11816
|
+
"default": 1
|
|
11642
11817
|
},
|
|
11643
11818
|
{
|
|
11644
11819
|
"name": "page_size",
|
|
11645
|
-
"type": "integer"
|
|
11820
|
+
"type": "integer",
|
|
11821
|
+
"minimum": 1,
|
|
11822
|
+
"maximum": 100,
|
|
11823
|
+
"default": 30
|
|
11646
11824
|
}
|
|
11647
11825
|
],
|
|
11648
11826
|
"intent": "Search users with access to a project",
|
|
@@ -11694,11 +11872,16 @@
|
|
|
11694
11872
|
},
|
|
11695
11873
|
{
|
|
11696
11874
|
"name": "p",
|
|
11697
|
-
"type": "integer"
|
|
11875
|
+
"type": "integer",
|
|
11876
|
+
"minimum": 1,
|
|
11877
|
+
"default": 1
|
|
11698
11878
|
},
|
|
11699
11879
|
{
|
|
11700
11880
|
"name": "page_size",
|
|
11701
|
-
"type": "integer"
|
|
11881
|
+
"type": "integer",
|
|
11882
|
+
"minimum": 1,
|
|
11883
|
+
"maximum": 100,
|
|
11884
|
+
"default": 30
|
|
11702
11885
|
}
|
|
11703
11886
|
],
|
|
11704
11887
|
"intent": "Search test case tags",
|
|
@@ -12146,7 +12329,8 @@
|
|
|
12146
12329
|
},
|
|
12147
12330
|
{
|
|
12148
12331
|
"name": "entity_type",
|
|
12149
|
-
"type": "string"
|
|
12332
|
+
"type": "string",
|
|
12333
|
+
"default": "TestCase"
|
|
12150
12334
|
},
|
|
12151
12335
|
{
|
|
12152
12336
|
"name": "place_holder_text",
|
|
@@ -12206,6 +12390,7 @@
|
|
|
12206
12390
|
"name": "name",
|
|
12207
12391
|
"type": "string",
|
|
12208
12392
|
"description": "Updated name of the dataset.",
|
|
12393
|
+
"minLength": 1,
|
|
12209
12394
|
"json_path": "/dataset/name"
|
|
12210
12395
|
},
|
|
12211
12396
|
{
|
|
@@ -12216,13 +12401,16 @@
|
|
|
12216
12401
|
{
|
|
12217
12402
|
"name": "name",
|
|
12218
12403
|
"type": "string",
|
|
12219
|
-
"required": true
|
|
12404
|
+
"required": true,
|
|
12405
|
+
"pattern": "^[\\p{L}][\\p{L}\\p{N}_]*$"
|
|
12220
12406
|
},
|
|
12221
12407
|
{
|
|
12222
12408
|
"name": "uuid",
|
|
12223
12409
|
"type": "string"
|
|
12224
12410
|
}
|
|
12225
12411
|
],
|
|
12412
|
+
"minItems": 1,
|
|
12413
|
+
"maxItems": 40,
|
|
12226
12414
|
"json_path": "/dataset/variables"
|
|
12227
12415
|
},
|
|
12228
12416
|
{
|
|
@@ -12238,13 +12426,16 @@
|
|
|
12238
12426
|
{
|
|
12239
12427
|
"name": "row_data",
|
|
12240
12428
|
"type": "array",
|
|
12241
|
-
"required": true
|
|
12429
|
+
"required": true,
|
|
12430
|
+
"minItems": 1
|
|
12242
12431
|
},
|
|
12243
12432
|
{
|
|
12244
12433
|
"name": "uuid",
|
|
12245
12434
|
"type": "string"
|
|
12246
12435
|
}
|
|
12247
12436
|
],
|
|
12437
|
+
"minItems": 1,
|
|
12438
|
+
"maxItems": 100,
|
|
12248
12439
|
"json_path": "/dataset/rows"
|
|
12249
12440
|
}
|
|
12250
12441
|
],
|
|
@@ -12336,6 +12527,8 @@
|
|
|
12336
12527
|
"type": "integer",
|
|
12337
12528
|
"example": 90,
|
|
12338
12529
|
"description": "Updated planned duration in minutes.",
|
|
12530
|
+
"minimum": 0,
|
|
12531
|
+
"maximum": 2147483647,
|
|
12339
12532
|
"json_path": "/exploratory_session/timebox_duration"
|
|
12340
12533
|
},
|
|
12341
12534
|
{
|
|
@@ -12343,6 +12536,8 @@
|
|
|
12343
12536
|
"type": "integer",
|
|
12344
12537
|
"example": 45,
|
|
12345
12538
|
"description": "Tracked duration in minutes.",
|
|
12539
|
+
"minimum": 0,
|
|
12540
|
+
"maximum": 2147483647,
|
|
12346
12541
|
"json_path": "/exploratory_session/duration"
|
|
12347
12542
|
},
|
|
12348
12543
|
{
|
|
@@ -12350,6 +12545,8 @@
|
|
|
12350
12545
|
"type": "integer",
|
|
12351
12546
|
"example": 50,
|
|
12352
12547
|
"description": "Final actual duration in minutes.",
|
|
12548
|
+
"minimum": 0,
|
|
12549
|
+
"maximum": 2147483647,
|
|
12353
12550
|
"json_path": "/exploratory_session/actual_duration"
|
|
12354
12551
|
},
|
|
12355
12552
|
{
|
|
@@ -12612,7 +12809,8 @@
|
|
|
12612
12809
|
"name": "name",
|
|
12613
12810
|
"type": "string",
|
|
12614
12811
|
"required": true,
|
|
12615
|
-
"description": "Name of the filter"
|
|
12812
|
+
"description": "Name of the filter",
|
|
12813
|
+
"minLength": 1
|
|
12616
12814
|
},
|
|
12617
12815
|
{
|
|
12618
12816
|
"name": "entity",
|
|
@@ -12689,7 +12887,8 @@
|
|
|
12689
12887
|
"name": "test_run_id",
|
|
12690
12888
|
"type": "string",
|
|
12691
12889
|
"required": true,
|
|
12692
|
-
"example": "TR-14"
|
|
12890
|
+
"example": "TR-14",
|
|
12891
|
+
"pattern": "^(TR-)?[0-9]+$"
|
|
12693
12892
|
},
|
|
12694
12893
|
{
|
|
12695
12894
|
"name": "test_case_id",
|
|
@@ -13306,12 +13505,14 @@
|
|
|
13306
13505
|
"name": "start_date",
|
|
13307
13506
|
"type": "string",
|
|
13308
13507
|
"description": "ISO-8601 date.",
|
|
13508
|
+
"format": "date",
|
|
13309
13509
|
"json_path": "/test_plan/start_date"
|
|
13310
13510
|
},
|
|
13311
13511
|
{
|
|
13312
13512
|
"name": "end_date",
|
|
13313
13513
|
"type": "string",
|
|
13314
13514
|
"description": "ISO-8601 date.",
|
|
13515
|
+
"format": "date",
|
|
13315
13516
|
"json_path": "/test_plan/end_date"
|
|
13316
13517
|
},
|
|
13317
13518
|
{
|
|
@@ -17238,13 +17439,13 @@
|
|
|
17238
17439
|
"type": "string",
|
|
17239
17440
|
"format": "uri",
|
|
17240
17441
|
"description": "Pre-signed S3 URL for viewing (inline, ~26 min expiry)",
|
|
17241
|
-
"example": "https://example.com/media/1/2921471/86de8094..."
|
|
17442
|
+
"example": "https://example.com/media/genric/1/2921471/86de8094..."
|
|
17242
17443
|
},
|
|
17243
17444
|
"download_url": {
|
|
17244
17445
|
"type": "string",
|
|
17245
17446
|
"format": "uri",
|
|
17246
17447
|
"description": "Pre-signed S3 URL for downloading (attachment, ~26 min expiry)",
|
|
17247
|
-
"example": "https://example.com/media/1/2921471/86de8094..."
|
|
17448
|
+
"example": "https://example.com/media/genric/1/2921471/86de8094..."
|
|
17248
17449
|
},
|
|
17249
17450
|
"content_type": {
|
|
17250
17451
|
"type": "string",
|
|
@@ -18355,7 +18556,7 @@
|
|
|
18355
18556
|
},
|
|
18356
18557
|
"selection": {
|
|
18357
18558
|
"type": "object",
|
|
18358
|
-
"description": "
|
|
18559
|
+
"description": "the primary project's persisted folder-structured test-case selection (with select_all / per-folder flags + unique_test_case_count), in the same shape as the test-run edit/selection endpoint. `{}` when the report has no saved selection for the primary project. Used by the Edit dialog to re-check saved test cases (including folder/project-level select_all, which the flat ids cannot represent).",
|
|
18359
18560
|
"example": {
|
|
18360
18561
|
"select_all": false,
|
|
18361
18562
|
"folders": {
|
|
@@ -18372,7 +18573,7 @@
|
|
|
18372
18573
|
},
|
|
18373
18574
|
"shared_selection": {
|
|
18374
18575
|
"type": "object",
|
|
18375
|
-
"description": "
|
|
18576
|
+
"description": "per-project folder-structured selection for the report's non-primary projects, keyed by project id ({ \"<project_id>\": <selection> }). Present only for cross-project Test Case Activity reports; `{}` otherwise.",
|
|
18376
18577
|
"example": {
|
|
18377
18578
|
"10209": {
|
|
18378
18579
|
"select_all": true,
|
|
@@ -19953,7 +20154,7 @@
|
|
|
19953
20154
|
"The read detail has NO data wrapper: the plan sits under a top-level test_plan key, and test_plan.identifier is the TP-NNN / STP-NNN.",
|
|
19954
20155
|
"Sub-plans are HIDDEN by default in the list. Without include_sub_plans=true you see only top-level plans, so a sub-plan the user named will look missing.",
|
|
19955
20156
|
"name IS REQUIRED ON EVERY PLAN UPDATE, including one that only touches test_runs. Omit it and the call is rejected with 400 {success: false, error: 'Invalid Update Params'} however valid the rest of the body is — the server's edit branch is gated on name being present. Read the plan first and echo its current name back unchanged. Only a pure plan_status transition and a reviewers-only edit are exempt. Verified live: {test_plan: {test_runs: [198]}} 400s; adding name makes the identical call succeed.",
|
|
19956
|
-
"Run ids in test_runs are the INTEGER uuid from a run read — NOT the run's id field, which is the TR-NNN string on every run endpoint (list, plan's run list, single detail alike). Identifiers are forwarded to the
|
|
20157
|
+
"Run ids in test_runs are the INTEGER uuid from a run read — NOT the run's id field, which is the TR-NNN string on every run endpoint (list, plan's run list, single detail alike). Identifiers are forwarded to the backing service uncoerced and fail upstream (observed 502 Upstream backing-service error). Take uuid, never id.",
|
|
19957
20158
|
"Linking a run MOVES it: a run belongs to at most one plan, so linking silently unlinks it from the plan that held it, with nothing in the 200 to say so. Read the runs' current membership first and tell the user which plans will lose runs. Verified live.",
|
|
19958
20159
|
"test_runs accepts an id array OR a bulk-selection object {select_all, de_selected_ids, search_query}. select_all means 'the newest active runs', NOT 'everything matching' — and `filters` is accepted but SILENTLY IGNORED, so a filtered select_all links the whole recent set. Narrow with search_query (name/identifier substring) or send explicit ids. Verified live.",
|
|
19959
20160
|
"bulk-archive / bulk-retrieve go ASYNC above the bulk threshold and return {success, async: true, unique_id} — the plans are NOT changed yet. Re-read to confirm; see async-jobs.",
|
|
@@ -20013,7 +20214,7 @@
|
|
|
20013
20214
|
"Only test_case_ids / selection / shared_selection put cases in a run. `filters` and `dynamic_filter` are a forward-sync rule, NOT a selection: a create carrying only `filters` returns 200 with ZERO cases, and sets is_dynamic: true even though you did not ask. Verified live.",
|
|
20014
20215
|
"Dynamic runs match on nine fields only: priority, status, category, owner, automation_status, automation_state, folder, tags, issues. created_at/updated_at are stored and echoed on read but NEVER matched, so a 'last 7 days' dynamic run drops the date window and over-collects forever. Create runs static unless the user explicitly asks for sync.",
|
|
20015
20216
|
"test_run.run_state is MANDATORY on create and edit (new_run | in_progress | under_review | rejected | done | closed). It is validated before the selection, so a bare 400 'invalid data' means a bad test_run field — NOT a bad selection shape.",
|
|
20016
|
-
"A run's `id` FIELD is the TR-NNN STRING, not the integer — on the project list, a plan's linked-run list and the single-run detail alike. The integer lives in `uuid` ({id: 'TR-90', uuid: 198}). Paths tolerate either form, which hides this; bodies and UI paths do not. Carrying `id` into a test plan's test_runs array sends a string that reaches the
|
|
20217
|
+
"A run's `id` FIELD is the TR-NNN STRING, not the integer — on the project list, a plan's linked-run list and the single-run detail alike. The integer lives in `uuid` ({id: 'TR-90', uuid: 198}). Paths tolerate either form, which hides this; bodies and UI paths do not. Carrying `id` into a test plan's test_runs array sends a string that reaches the backing service uncoerced and 502s there. Take `uuid` whenever a run id leaves a read.",
|
|
20017
20218
|
"Full lifecycle is exposed: create, edit, assign, bulk-assign cases, bulk-edit results, clone, close, delete."
|
|
20018
20219
|
]
|
|
20019
20220
|
},
|