Release playwrighttesting microsoft.playwright testing.auth manager 2024 12 01 #31855

mjmadhu · 2024-12-12T09:26:24Z

Data Plane API Specification Update Pull Request

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.

Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.

Updated the API version from preview/2023-10-01-preview to stable/2024-12-01.

openapi-pipeline-app · 2024-12-12T09:26:29Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This is the public specs repo main branch which is not intended for iterative development.
You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
If this is what you intend, add PublishToCustomers label to your PR.
Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
❌ Your PR requires an API stewardship board review as it introduces a new API version (label: new-api-version). Schedule the review by following aka.ms/azsdk/onboarding/restapischedule.
❌ The required check named Swagger LintDiff has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

openapi-pipeline-app · 2024-12-12T09:26:29Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/playwrighttesting/armplaywrighttesting	There is no API change compared with the previous version
JavaScript	@azure/arm-playwrighttesting	https://apiview.dev/Assemblies/Review/3a5ef77675cd496b8ea7476458ea8d4b?revisionId=1072258d5c3042c29eb72d0e79d79a2f
JavaScript	@azure-rest/microsoft-playwright-testing	https://apiview.dev/Assemblies/Review/6df4877534fc43c9a3414f783f4a4ee6?revisionId=08b144c880f64e3aa6f7e2cca7ee3be5
Java	azure-developer-microsoftplaywrighttesting	https://apiview.dev/Assemblies/Review/5a14b0d42e2547158388bd3df7bbdfc6?revisionId=986c5e49ee63444d9210cd3730d7e6a7
Java	azure-resourcemanager-playwrighttesting	https://apiview.dev/Assemblies/Review/1bd459ec74cb4a53a4d19cdb7e9db406?revisionId=88bda2c24c6e411ea0b8b2473a17c3a6
Python	azure-developer-microsoftplaywrighttesting	https://apiview.dev/Assemblies/Review/e237446c5ce54ef4b6dd919cd972c074?revisionId=7cc3b6b9afb840f6ab2fd0b50dd177dc
Python	azure-mgmt-playwrighttesting	https://apiview.dev/Assemblies/Review/2213c5dc9a8f4408a2b0c3b87606308c?revisionId=d07efa93a8fd461f97135d1651624f78
TypeSpec	PlaywrightTesting.Management	https://apiview.dev/Assemblies/Review/8d7e4b8460bd4874b59430d6790390d8?revisionId=11850451242f40cdac0b76599775b551

...a-plane/Microsoft.PlaywrightTesting.AuthManager/stable/2024-12-01/examples/Accounts_Get.json

…sting.AuthManager-2024-12-01-devv

mikekistler

Looks good. 👍

Left one minor comment on eliminating uncommon acronyms.

mikekistler · 2024-12-18T15:51:53Z

.../data-plane/Microsoft.PlaywrightTesting.AuthManager/stable/2024-12-01/playwrighttesting.json

+    "/accounts/{accountId}/access-tokens/validate": {
+      "post": {
+        "operationId": "AccessTokens_Validate",
+        "description": "Validates access-token provided in authorization header for the given account id. Authorization required is Bearer JWT Access token provided by MPT service.",


Here and in a few other spots there is the acronym "MPT" -- is this "Microsoft Playwright Service"? It might be better to spell this out.

…sting.AuthManager-2024-12-01-devv

weidongxu-microsoft · 2024-12-23T02:42:43Z

specification/playwrighttesting/PlaywrightTesting.AuthManager/main.tsp

+  @doc("Linux OS.")
+  Linux: "linux",
+
+  @doc("Windows OS.")
+  Windows: "windows",


Not a blocker, but we'd expect the casing of enum values be consistent. Here is it lowercase/camelCase e.g. linux, and the enum value above is PascalCase e.g. Active. Any reason for this inconsistency?

weidongxu-microsoft · 2024-12-23T02:44:28Z

specification/playwrighttesting/PlaywrightTesting.AuthManager/main.tsp

+  @path
+  @doc("The account id.")
+  accountId: string;


I am not sure how much it effects the Swagger or API. But I'd expect the most important parameter (I assume it be accountId) at the top.

weidongxu-microsoft · 2024-12-23T02:52:03Z

specification/playwrighttesting/PlaywrightTesting.AuthManager/main.tsp

  @doc("When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.")
  @visibility("read")
-  reporting?: EnablementStatus = EnablementStatus.Disabled;
+  reporting?: EnablementStatus = EnablementStatus.Enabled;
+
+  @doc("When enabled, this feature allows the workspace to use local auth (through service access token) for executing operations.")
+  @visibility("read")
+  localAuth?: EnablementStatus = EnablementStatus.Disabled;


Why there is a service-side default value (e.g. EnablementStatus.Disabled) to this already read-only property?
A server-side default value is used when user does not define the property in request (e.g. a PUT), and server choose the value. How does this work together with a property user cannot set?

And since the e.g. localAuth? is an optional property, what does it mean, when the response does not contain localAuth. Is it "disabled" or "enabled"?

mjmadhu added 5 commits December 12, 2024 12:58

Copy files from preview/2023-10-01-preview

a26928d

Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.

Update version to stable/2024-12-01

36c6afd

Updated the API version from preview/2023-10-01-preview to stable/2024-12-01.

Added tag for 2024-12-01 in readme file

52a1a37

Added stable api-version for data-plane auth manager apis

9cc3283

Rectified a typo

1db7b13

mjmadhu requested a review from a team as a code owner December 12, 2024 09:26

mjmadhu requested review from allenjzhang and mario-guerra and removed request for a team December 12, 2024 09:26

mjmadhu requested review from puagarwa and prakash-amit December 12, 2024 09:27

mjmadhu enabled auto-merge (squash) December 12, 2024 09:31

prakash-amit approved these changes Dec 12, 2024

View reviewed changes

AzureRestAPISpecReview added data-plane TypeSpec Authored with TypeSpec labels Dec 12, 2024

Typespec Validation error resolved

2cb194c

puagarwa approved these changes Dec 12, 2024

View reviewed changes

...a-plane/Microsoft.PlaywrightTesting.AuthManager/stable/2024-12-01/examples/Accounts_Get.json Show resolved Hide resolved

Typespec Validation error resolved

0bdfe05

mjmadhu changed the base branch from release-playwrighttesting-Microsoft.PlaywrightTesting.AuthManager-2024-12-01-devv to release-playwrighttesting-Microsoft.PlaywrightTesting.AuthManager-2024-12-01 December 12, 2024 10:21

mjmadhu changed the title ~~Rectified a typo~~ Added stable api-version for data-plane auth manager apis Dec 12, 2024

azure-sdk mentioned this pull request Dec 12, 2024

[AutoPR Azure.ResourceManager.PlaywrightTesting] Release playwrighttesting microsoft.playwright testing.auth manager 2024 12 01 azure-sdk/azure-sdk-for-net#10022

Draft

TSP Validation fix trial

c8216f4

puagarwa approved these changes Dec 16, 2024

View reviewed changes

mjmadhu and others added 3 commits December 17, 2024 09:48

Merge branch 'main' into dev-playwrighttesting-Microsoft.PlaywrightTe…

0bb3649

…sting.AuthManager-2024-12-01-devv

Added trailing newline char in tspconfig.yaml

74b8e47

Typespec validation errors fix

91818d6

AzureRestAPISpecReview added ARMReview resource-manager RPaaS WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 17, 2024

mjmadhu added 2 commits December 17, 2024 12:21

Committing changes by npx tsv

528ca41

Update formatting

3f602d2

mjmadhu added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 17, 2024

mjmadhu and others added 2 commits December 17, 2024 15:11

Merge branch 'main' into dev-playwrighttesting-Microsoft.PlaywrightTe…

2cc2e53

…sting.AuthManager-2024-12-01-devv

Added suppression and bit more documentation in comments

c21633b

AzureRestAPISpecReview added the SuppressionReviewRequired label Dec 17, 2024

mjmadhu and others added 3 commits December 18, 2024 11:50

Merge branch 'main' into dev-playwrighttesting-Microsoft.PlaywrightTe…

381b8a0

…sting.AuthManager-2024-12-01-devv

Merge branch 'main' into dev-playwrighttesting-Microsoft.PlaywrightTe…

6f33e52

…sting.AuthManager-2024-12-01-devv

Suppression improvement

7ce268b

mikekistler approved these changes Dec 18, 2024

View reviewed changes

msyyc added the BreakingChange-Python-Sdk-Approved label Dec 19, 2024

mjmadhu and others added 4 commits December 19, 2024 17:39

Merge branch 'main' into dev-playwrighttesting-Microsoft.PlaywrightTe…

5d76723

…sting.AuthManager-2024-12-01-devv

Removed validate access token api as suggested in review feedback

15d8881

Added suppressions for swagger lintdiff issues

96a2f69

Added suppressions for swagger lintdiff issues

c280115

mikekistler linked an issue Dec 21, 2024 that may be closed by this pull request

[Playwright-DevDiv-Service - Playwright] API Review #31794

Open

weidongxu-microsoft reviewed Dec 23, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release playwrighttesting microsoft.playwright testing.auth manager 2024 12 01 #31855

Release playwrighttesting microsoft.playwright testing.auth manager 2024 12 01 #31855

mjmadhu commented Dec 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Dec 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Dec 12, 2024 •

edited

Loading

mikekistler left a comment

mikekistler Dec 18, 2024

weidongxu-microsoft Dec 23, 2024 •

edited

Loading

weidongxu-microsoft Dec 23, 2024

weidongxu-microsoft Dec 23, 2024 •

edited

Loading

Release playwrighttesting microsoft.playwright testing.auth manager 2024 12 01 #31855

Are you sure you want to change the base?

Release playwrighttesting microsoft.playwright testing.auth manager 2024 12 01 #31855

Conversation

mjmadhu commented Dec 12, 2024 • edited Loading

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

openapi-pipeline-app bot commented Dec 12, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Dec 12, 2024 • edited Loading

Generated ApiView

mikekistler left a comment

Choose a reason for hiding this comment

mikekistler Dec 18, 2024

Choose a reason for hiding this comment

weidongxu-microsoft Dec 23, 2024 • edited Loading

Choose a reason for hiding this comment

weidongxu-microsoft Dec 23, 2024

Choose a reason for hiding this comment

weidongxu-microsoft Dec 23, 2024 • edited Loading

Choose a reason for hiding this comment

mjmadhu commented Dec 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Dec 12, 2024 •

edited

Loading

openapi-pipeline-app bot commented Dec 12, 2024 •

edited

Loading

weidongxu-microsoft Dec 23, 2024 •

edited

Loading

weidongxu-microsoft Dec 23, 2024 •

edited

Loading