Data Plane - Microsoft.AzurePlaywrightService integration into Microsoft.LoadTestService by mjmadhu · Pull Request #34012 · Azure/azure-rest-api-specs

mjmadhu · 2025-04-17T05:41:59Z

Data Plane API Specification Update Pull Request

Link for Control Plane PR - Control Plane - Microsoft.AzurePlaywrightService integration into Microsoft.LoadTestService #33891
We've a business ask to merge Azure Testing Services under one umbrella.
Microsoft.LoadTestService is a GA RP so we want to merge another preview RP (called Microsoft.AzurePlaywrightService) into it as a separate resource type called "Playwright Workspaces", reflecting changes in all data-plane api-signatures as well.
Later on, RP Microsoft.AzurePlaywrightService would be deprecated as per ARM deprecation guidelines.
The First Commit in the PR is taken from existing data-plane files of Microsoft.AzurePlaywrightService for clear visibility in PR review.
Also, we want to avoid any unwanted change/impact to the already GA APIs and SDKs of Microsoft.LoadTestService (given involvement of different teams), hence we'd prefer to go in separate folder namespace as far as possible.

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

Link to API Spec engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

Design Document:
Previous API Spec Doc:
Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

Getting help

First, please carefully read through this PR description, from top to bottom.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

…t.LaodTestService

openapi-pipeline-app · 2025-04-17T05:42:03Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2025-04-17T05:42:04Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

github-actions · 2025-04-17T05:45:00Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
TypeSpec	Playwright
Java	com.azure:azure-developer-loadtesting
Java	com.azure:azure-developer-playwright
Python	azure-developer-loadtesting
Python	azure-developer-playwright
JavaScript	@azure-rest/playwright
Swagger	loadtesting-loadtesting
Swagger	loadtesting-playwright
JavaScript	@azure-rest/load-testing

…into malt-mpt-integration-dataplane

abranj19 · 2025-06-13T10:35:32Z

+  @doc("Creates/Updates a test-run for the workspace with given test-run id. Authorization required is Bearer JWT Access token provided by EntraID or Playwright Service.")
+  createOrUpdate is Operations.ResourceCreateOrUpdate<TestRun>;
+
+  @doc("Lists test-runs for the given workspace id. It can use OData query params like $select, $filter, $orderby, $top and $skip. The default page size is 10. Use nextLink in response to fetch more objects in the list. Authorization required is Bearer JWT Access token provided by EntraID or Playwright Service.")


Pls see what all filters are supported here and provide more details there

qiaozha · 2025-06-17T01:50:04Z

/azp run

azure-pipelines · 2025-06-17T01:50:10Z

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

…into malt-mpt-integration-dataplane

qiaozha · 2025-06-17T23:52:41Z

@JeffreyRichter I think the breaking change in this PR can be approved as they are false alarm for moving files into different folders for loadtesting service.

@mjmadhu I want to confirm with you that this PR is just merging the playwrightservice spec into loadtesting service, it's not adding a new service, right ? If yes, then @JeffreyRichter it's okay to sign off from the API stewardship board. If no, @mjmadhu you need to have a review meeting with them to get the sign off label.

…into malt-mpt-integration-dataplane

mjmadhu · 2025-06-23T07:01:11Z

@JeffreyRichter I think the breaking change in this PR can be approved as they are false alarm for moving files into different folders for loadtesting service.

@mjmadhu I want to confirm with you that this PR is just merging the playwrightservice spec into loadtesting service, it's not adding a new service, right ? If yes, then @JeffreyRichter it's okay to sign off from the API stewardship board. If no, @mjmadhu you need to have a review meeting with them to get the sign off label.

Hi, it's not a new spec and we've just migrated already approved/existing specs of playwright in loadtestservice RP.

abranj19

Approved changes regarding reporting feature removal fields, but someone else should have a look as well for final approval. / @mikekistler

qiaozha · 2025-06-23T12:56:21Z

Checkout here on what's blocking the merge https://github.com/Azure/azure-rest-api-specs/pull/34012/checks?check_run_id=44581671861

mikekistler

Looks good. 👍

weidongxu-microsoft · 2025-08-08T10:06:51Z

    generate-tests: false
    generate-samples: false
-    service-name: Load Testing
+    service-name: Load Test


@mjmadhu
Would you let me know the reason why you change the service-name?

This value affect name of Java SDK class LoadTestingServiceVersion.
https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/loadtesting/azure-developer-loadtesting/src/main/java/com/azure/developer/loadtesting/LoadTestingServiceVersion.java
With this change, this class would be named LoadTestServiceVersion, and a change to public class name is a breaking change.

mjmadhu added 2 commits April 17, 2025 10:57

First commit of adding existing Playwright Dataplane APIs in Microsof…

83ee5eb

…t.LaodTestService

Added APIs for Playwright in Microsoft.Loadtestservice

45940d6

microsoft-github-policy-service Bot added the Load Test Service Azure Load Test Service label Apr 17, 2025

Merge branch 'main' into malt-mpt-integration-dataplane

52a6fca

mjmadhu marked this pull request as ready for review April 17, 2025 05:45

mjmadhu requested a review from a team as a code owner April 17, 2025 05:45

mjmadhu requested review from johanste and tg-msft April 17, 2025 05:45

AzureRestAPISpecReview added data-plane new-api-version TypeSpec Authored with TypeSpec labels Apr 17, 2025

azure-sdk added the BreakingChange-JavaScript-Sdk label Apr 17, 2025

Added readme changes for fixing CI failures

5002beb

openapi-pipeline-app Bot added PipelineBotTrigger and removed PipelineBotTrigger labels Apr 17, 2025

mjmadhu added 3 commits June 13, 2025 11:43

Merge branch 'main' of https://github.com/Azure/azure-rest-api-specs …

4a502de

…into malt-mpt-integration-dataplane

Updated tspconfig.yaml

f1a0f3e

TSP Validation fix

ed8f279

abranj19 reviewed Jun 13, 2025

View reviewed changes

qiaozha reviewed Jun 17, 2025

View reviewed changes

Comment thread ...service/data-plane/Microsoft.LoadTestService/preview/2021-07-01-preview/loadtestservice.json

prakash-amit reviewed Jun 17, 2025

View reviewed changes

Comment thread specification/loadtestservice/Playwright/models.tsp

mjmadhu added 3 commits June 17, 2025 16:10

Merge branch 'main' of https://github.com/Azure/azure-rest-api-specs …

23ca2ba

…into malt-mpt-integration-dataplane

Review comments on Test run model

b145fc1

Review comments on Test run model

916d9ff

mjmadhu and others added 3 commits June 18, 2025 12:23

Merge branch 'main' of https://github.com/Azure/azure-rest-api-specs …

2567d9a

…into malt-mpt-integration-dataplane

Fixed Typo in property name for model validation

0b2c892

Merge branch 'main' into malt-mpt-integration-dataplane

b45bb0a

mjmadhu added 5 commits June 23, 2025 12:49

TSP Validation fix

6b7669d

TSP Validation fix

35fb2d4

TSP Validation fix

4303998

TSP Validation fix

3e64c22

TSP Validation fix

d00ede8

abranj19 approved these changes Jun 23, 2025

View reviewed changes

mikekistler approved these changes Jun 24, 2025

View reviewed changes

qiaozha reviewed Jun 25, 2025

View reviewed changes

Comment thread specification/loadtestservice/data-plane/playwright/readme.md

qiaozha reviewed Jun 25, 2025

View reviewed changes

Comment thread specification/loadtestservice/Playwright/routes.tsp

weidongxu-microsoft reviewed Aug 8, 2025

View reviewed changes

This was referenced Aug 8, 2025

[Automation] Generate SDK based on TypeSpec 0.32.0 Azure/azure-sdk-for-java#46324

Merged

java, loadtesting, Update tspconfig.yaml #36583

Merged

Conversation

mjmadhu commented Apr 17, 2025

Data Plane API Specification Update Pull Request

PR review workflow diagram

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Getting help

Uh oh!

openapi-pipeline-app Bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app Bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abranj19 Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qiaozha commented Jun 17, 2025

Uh oh!

azure-pipelines Bot commented Jun 17, 2025

Uh oh!

Uh oh!

Uh oh!

qiaozha commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mjmadhu commented Jun 23, 2025

Uh oh!

abranj19 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiaozha commented Jun 23, 2025

Uh oh!

mikekistler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

weidongxu-microsoft Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

openapi-pipeline-app Bot commented Apr 17, 2025 •

edited

Loading

openapi-pipeline-app Bot commented Apr 17, 2025 •

edited

Loading

github-actions Bot commented Apr 17, 2025 •

edited

Loading

qiaozha commented Jun 17, 2025 •

edited

Loading

abranj19 left a comment •

edited

Loading

weidongxu-microsoft Aug 8, 2025 •

edited

Loading