Skip to content

Commit 2161481

Browse files
krishna1sKrishna ChandakHarshan01Harshan B
authored and
kayousef
committed
Loadtest stableapis (Azure#21672)
* publishing stable api version 2022-11-01 for load test service * prettier run * spell check * changing swagger back to 2.0 * adding description * prettier changes * renaming opertation id * adding x-ms-enum extension * validation fixes * renaming examples * review changes * adding x-ms-parameter-location * review fixes * removing required field * adding x-ms-enum values * prettier fix * spell fixes * prettier fix * adding new metrics and app component apis * updating examples * removing list resource type api * changing to kebab case * changing x-ms-parameter-location value for sdk * updating example * removing resourceId * removing resource Id from examples * adding missing desc * removing read only properties from examples * spell fix * review fixes * mode renaming * properties changes in examples * renaming * Update loadtestservice.json * renaming properties * renaming property * desc changes * Add readme SDK changes (Azure#21315) Co-authored-by: Harshan B <[email protected]> * review changes 1. adding file with application octet stream 2.taking fileName as param instead of fileId 3. adding new api for metrics dimension values 4. simplifying metrics api * model validation fixes * spell fixes * updating desc for search and orderby * desc changes * adding 201 response * adding 201 status code * sdk consistency changes * filename renaming * renaming file info * adding default pass fail criteria action value * changing operation id and adding x-ms-pageable attributes * adding Test or Test Run in operation id * updating operation id * adding test suffix in operation id * removing the test suffix * changing operation id * changing example response * updating operation ids Co-authored-by: Krishna Chandak <[email protected]> Co-authored-by: Harshan B <[email protected]> Co-authored-by: Harshan B <[email protected]>
1 parent fed2c56 commit 2161481

File tree

2 files changed

+79
-73
lines changed

2 files changed

+79
-73
lines changed

‎specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/examples/ListTestRunMetrics.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"responses": {
2222
"200": {
2323
"body": {
24-
"timeseries": [
24+
"value": [
2525
{
2626
"data": [
2727
{

‎specification/loadtestservice/data-plane/Microsoft.LoadTestService/stable/2022-11-01/loadtestservice.json

Lines changed: 78 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"Test"
1313
],
1414
"summary": "Create a new test or update an existing test.",
15-
"operationId": "Test_CreateOrUpdate",
15+
"operationId": "LoadTestAdministration_CreateOrUpdateTest",
1616
"consumes": [
1717
"application/merge-patch+json"
1818
],
@@ -73,7 +73,7 @@
7373
"Test"
7474
],
7575
"summary": "Delete a test by its name.",
76-
"operationId": "Test_Delete",
76+
"operationId": "LoadTestAdministration_DeleteTest",
7777
"produces": [
7878
"application/json"
7979
],
@@ -113,7 +113,7 @@
113113
"Test"
114114
],
115115
"summary": "Get load test details by test name",
116-
"operationId": "Test_Get",
116+
"operationId": "LoadTestAdministration_GetTest",
117117
"produces": [
118118
"application/json"
119119
],
@@ -158,7 +158,7 @@
158158
"Test"
159159
],
160160
"summary": "Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.",
161-
"operationId": "Test_List",
161+
"operationId": "LoadTestAdministration_ListTests",
162162
"produces": [
163163
"application/json"
164164
],
@@ -243,7 +243,7 @@
243243
"Test"
244244
],
245245
"summary": "Upload input file for a given test name. File size can't be more than 50 MB. Existing file with same name for the given test will be overwritten. File should be provided in the request body as application/octet-stream.",
246-
"operationId": "Test_UploadFile",
246+
"operationId": "LoadTestAdministration_UploadTestFile",
247247
"consumes": [
248248
"application/octet-stream"
249249
],
@@ -335,7 +335,7 @@
335335
"Test"
336336
],
337337
"summary": "Get test file by the file name.",
338-
"operationId": "Test_GetFile",
338+
"operationId": "LoadTestAdministration_GetTestFile",
339339
"produces": [
340340
"application/json"
341341
],
@@ -385,7 +385,7 @@
385385
"Test"
386386
],
387387
"summary": "Delete file by the file name for a test",
388-
"operationId": "Test_DeleteFile",
388+
"operationId": "LoadTestAdministration_DeleteTestFile",
389389
"produces": [
390390
"application/json"
391391
],
@@ -434,7 +434,7 @@
434434
"Test"
435435
],
436436
"summary": "Get all test files.",
437-
"operationId": "Test_ListFiles",
437+
"operationId": "LoadTestAdministration_ListTestFiles",
438438
"produces": [
439439
"application/json"
440440
],
@@ -488,7 +488,7 @@
488488
"Test"
489489
],
490490
"summary": "Associate an app component (collection of azure resources) to a test",
491-
"operationId": "Test_CreateOrUpdateAppComponents",
491+
"operationId": "LoadTestAdministration_CreateOrUpdateAppComponents",
492492
"consumes": [
493493
"application/merge-patch+json"
494494
],
@@ -549,7 +549,7 @@
549549
"Test"
550550
],
551551
"summary": "Get associated app component (collection of azure resources) for the given test.",
552-
"operationId": "Test_ListAppComponents",
552+
"operationId": "LoadTestAdministration_GetAppComponents",
553553
"produces": [
554554
"application/json"
555555
],
@@ -594,7 +594,7 @@
594594
"Test"
595595
],
596596
"summary": "Configure server metrics for a test",
597-
"operationId": "Test_CreateOrUpdateServerMetricsConfig",
597+
"operationId": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig",
598598
"consumes": [
599599
"application/merge-patch+json"
600600
],
@@ -655,7 +655,7 @@
655655
"Test"
656656
],
657657
"summary": "List server metrics configuration for the given test.",
658-
"operationId": "Test_ListServerMetricsConfig",
658+
"operationId": "LoadTestAdministration_GetServerMetricsConfig",
659659
"produces": [
660660
"application/json"
661661
],
@@ -695,52 +695,12 @@
695695
}
696696
},
697697
"/test-runs/{testRunId}": {
698-
"delete": {
699-
"tags": [
700-
"TestRun"
701-
],
702-
"summary": "Delete a test run by its name.",
703-
"operationId": "TestRun_Delete",
704-
"produces": [
705-
"application/json"
706-
],
707-
"parameters": [
708-
{
709-
"$ref": "#/parameters/TestRunIdPathParameter"
710-
},
711-
{
712-
"$ref": "#/parameters/ApiVersion"
713-
}
714-
],
715-
"responses": {
716-
"204": {
717-
"description": "The test run is deleted."
718-
},
719-
"default": {
720-
"description": "Load Testing service error response.",
721-
"schema": {
722-
"$ref": "#/definitions/ErrorResponseBody"
723-
},
724-
"headers": {
725-
"x-ms-error-code": {
726-
"description": "The error code for specific error that occurred.",
727-
"type": "string"
728-
}
729-
}
730-
}
731-
},
732-
"x-ms-examples": {
733-
"Delete a test run": {
734-
"$ref": "./examples/DeleteTestRun.json"
735-
}
736-
}
737-
},
738698
"patch": {
739699
"tags": [
740700
"TestRun"
741701
],
742702
"summary": "Create and start a new test run with the given name.",
743-
"operationId": "TestRun_CreateOrUpdate",
703+
"operationId": "LoadTestRun_CreateOrUpdateTestRun",
744704
"consumes": [
745705
"application/merge-patch+json"
746706
],
@@ -807,7 +767,7 @@
807767
"TestRun"
808768
],
809769
"summary": "Get test run details by name.",
810-
"operationId": "TestRun_Get",
770+
"operationId": "LoadTestRun_GetTestRun",
811771
"produces": [
812772
"application/json"
813773
],
@@ -844,6 +804,46 @@
844804
"$ref": "./examples/GetTestRun.json"
845805
}
846806
}
807+
},
808+
"delete": {
809+
"tags": [
810+
"TestRun"
811+
],
812+
"summary": "Delete a test run by its name.",
813+
"operationId": "LoadTestRun_DeleteTestRun",
814+
"produces": [
815+
"application/json"
816+
],
817+
"parameters": [
818+
{
819+
"$ref": "#/parameters/TestRunIdPathParameter"
820+
},
821+
{
822+
"$ref": "#/parameters/ApiVersion"
823+
}
824+
],
825+
"responses": {
826+
"204": {
827+
"description": "The test run is deleted."
828+
},
829+
"default": {
830+
"description": "Load Testing service error response.",
831+
"schema": {
832+
"$ref": "#/definitions/ErrorResponseBody"
833+
},
834+
"headers": {
835+
"x-ms-error-code": {
836+
"description": "The error code for specific error that occurred.",
837+
"type": "string"
838+
}
839+
}
840+
}
841+
},
842+
"x-ms-examples": {
843+
"Delete a test run": {
844+
"$ref": "./examples/DeleteTestRun.json"
845+
}
846+
}
847847
}
848848
},
849849
"/test-runs/{testRunId}/files/{fileName}": {
@@ -852,7 +852,7 @@
852852
"TestRun"
853853
],
854854
"summary": "Get test run file by file name.",
855-
"operationId": "TestRun_GetFile",
855+
"operationId": "LoadTestRun_GetTestRunFile",
856856
"produces": [
857857
"application/json"
858858
],
@@ -904,7 +904,7 @@
904904
"TestRun"
905905
],
906906
"summary": "Get all test runs with given filters",
907-
"operationId": "TestRun_List",
907+
"operationId": "LoadTestRun_ListTestRuns",
908908
"produces": [
909909
"application/json"
910910
],
@@ -998,7 +998,7 @@
998998
"TestRun"
999999
],
10001000
"summary": "Stop test run by name.",
1001-
"operationId": "TestRun_Stop",
1001+
"operationId": "LoadTestRun_StopTestRun",
10021002
"produces": [
10031003
"application/json"
10041004
],
@@ -1043,7 +1043,7 @@
10431043
"TestRun"
10441044
],
10451045
"summary": "List the metric namespaces for a load test run.",
1046-
"operationId": "TestRun_ListMetricNamespaces",
1046+
"operationId": "LoadTestRun_ListMetricNamespaces",
10471047
"produces": [
10481048
"application/json"
10491049
],
@@ -1088,7 +1088,7 @@
10881088
"TestRun"
10891089
],
10901090
"summary": "List the metric definitions for a load test run.",
1091-
"operationId": "TestRun_ListMetricDefinitions",
1091+
"operationId": "LoadTestRun_ListMetricDefinitions",
10921092
"produces": [
10931093
"application/json"
10941094
],
@@ -1140,7 +1140,7 @@
11401140
"TestRun"
11411141
],
11421142
"summary": "List the metric values for a load test run.",
1143-
"operationId": "TestRun_ListMetrics",
1143+
"operationId": "LoadTestRun_ListMetrics",
11441144
"consumes": [
11451145
"application/json"
11461146
],
@@ -1254,6 +1254,9 @@
12541254
"Lists the metric values for a load test run.": {
12551255
"$ref": "./examples/ListTestRunMetrics.json"
12561256
}
1257+
},
1258+
"x-ms-pageable": {
1259+
"nextLinkName": "nextLink"
12571260
}
12581261
}
12591262
},
@@ -1263,7 +1266,7 @@
12631266
"TestRun"
12641267
],
12651268
"summary": "List the dimension values for the given metric dimension name.",
1266-
"operationId": "TestRun_ListMetricDimensionValues",
1269+
"operationId": "LoadTestRun_ListMetricDimensionValues",
12671270
"produces": [
12681271
"application/json"
12691272
],
@@ -1367,6 +1370,9 @@
13671370
"Lists the metric dimension values for a load test run.": {
13681371
"$ref": "./examples/ListMetricDimensionValues.json"
13691372
}
1373+
},
1374+
"x-ms-pageable": {
1375+
"nextLinkName": "nextLink"
13701376
}
13711377
}
13721378
},
@@ -1376,7 +1382,7 @@
13761382
"TestRun"
13771383
],
13781384
"summary": "Associate an app component (collection of azure resources) to a test run",
1379-
"operationId": "TestRun_CreateOrUpdateAppComponents",
1385+
"operationId": "LoadTestRun_CreateOrUpdateAppComponents",
13801386
"consumes": [
13811387
"application/merge-patch+json"
13821388
],
@@ -1437,7 +1443,7 @@
14371443
"TestRun"
14381444
],
14391445
"summary": "Get associated app component (collection of azure resources) for the given test run.",
1440-
"operationId": "TestRun_ListAppComponents",
1446+
"operationId": "LoadTestRun_GetAppComponents",
14411447
"produces": [
14421448
"application/json"
14431449
],
@@ -1482,7 +1488,7 @@
14821488
"TestRun"
14831489
],
14841490
"summary": "Configure server metrics for a test run",
1485-
"operationId": "TestRun_CreateOrUpdateServerMetricsConfig",
1491+
"operationId": "LoadTestRun_CreateOrUpdateServerMetricsConfig",
14861492
"consumes": [
14871493
"application/merge-patch+json"
14881494
],
@@ -1543,7 +1549,7 @@
15431549
"TestRun"
15441550
],
15451551
"summary": "List server metrics configuration for the given test run.",
1546-
"operationId": "TestRun_ListServerMetricsConfig",
1552+
"operationId": "LoadTestRun_GetServerMetricsConfig",
15471553
"produces": [
15481554
"application/json"
15491555
],
@@ -2142,7 +2148,7 @@
21422148
"description": "The response to a metrics query.",
21432149
"type": "object",
21442150
"properties": {
2145-
"timeseries": {
2151+
"value": {
21462152
"description": "Timeseries data for metric query.",
21472153
"type": "array",
21482154
"items": {
@@ -2322,21 +2328,21 @@
23222328
"description": "Action taken after the threshold is met. Default is ‘continue’.",
23232329
"default": "continue",
23242330
"enum": [
2325-
"stop",
2326-
"continue"
2331+
"continue",
2332+
"stop"
23272333
],
23282334
"type": "string",
23292335
"x-ms-enum": {
23302336
"name": "PFAction",
23312337
"modelAsString": true,
23322338
"values": [
2333-
{
2334-
"value": "stop",
2335-
"description": "Test run will stop if pass fail criteria metric is not passed."
2336-
},
23372339
{
23382340
"value": "continue",
23392341
"description": "Test will continue to run even if pass fail metric criteria metric gets failed"
2342+
},
2343+
{
2344+
"value": "stop",
2345+
"description": "Test run will stop if pass fail criteria metric is not passed."
23402346
}
23412347
]
23422348
}

0 commit comments

Comments
 (0)