[Playwright-DevDiv-Service - Playwright] API Review

[azure-sdk]

New API Review meeting has been requested.

Service Name: Playwright-DevDiv-Service - Playwright
Review Created By: Vansh Singh
Review Date: 01/22/2025 09:00 AM PT
Release Plan: 1533
PR: https://github.com/Azure/azure-rest-api-specs-pr/pull/14260
Hero Scenarios Link: here
Core Concepts Doc Link: here

Description: Microsoft Playwright Testing is an Azure service built on Playwright OSS that allows users to run tests on browsers hosted and managed by the service. It also enables publishing test results and artifacts to the service, which can then be accessed and analyzed through a dashboard.

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

[azure-sdk]

Meeting updated by Manivelu Rajendran

Service Name: Playwright-DevDiv-Service - Playwright
Review Created By: Vansh Singh
Review Date: 01/22/2025 09:00 AM PT
Release Plan: 1533
PR: https://github.com/Azure/azure-rest-api-specs-pr/pull/14260
Hero Scenarios Link: here
Core Concepts Doc Link: here

Description: Microsoft Playwright Testing is an Azure service built on Playwright OSS that allows users to run tests on browsers hosted and managed by the service. It also enables publishing test results and artifacts to the service, which can then be accessed and analyzed through a dashboard.

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

[azure-sdk]

Meeting updated by Manivelu Rajendran

Service Name: Playwright-DevDiv-Service - Playwright
Review Created By: Vansh Singh
Review Date: 01/22/2025 09:00 AM PT
Release Plan: 1533
PR: https://github.com/Azure/azure-rest-api-specs-pr/pull/14260
Hero Scenarios Link: here
Core Concepts Doc Link: here

Description: Microsoft Playwright Testing is an Azure service built on Playwright OSS that allows users to run tests on browsers hosted and managed by the service. It also enables publishing test results and artifacts to the service, which can then be accessed and analyzed through a dashboard.

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here

[mikekistler]

Notes from API Review 1/23/25

PR link: #32020

• Should probably remove actionSeparator("/") -- use the default ":"
• Actions will be POST but the API is "get" -- needs to be reconciled
  • Maybe use some synonym for "get" that conveys that some computation is done
  • Maybe "aggregate" ?
  • But no strong objection to "get" if you want to keep it
  • Action should be a verb -- maybe "summarize"
• Does summary return a collection? No ... the summary is just a collection of stats
• Any strings that can be provided by the user should have maxLength and specify allowed characters (with pattern)
• Ids should be case-sensitive -- and you should document that
  • If you need to have case-insensitive we should discuss that to understand why
• Use Pascal case for enum values
• Durations should use TypeSpec durations (see Ted's comments in the APIView)
  • And the descriptions must clearly specify the time units
• Rather that "Num"XXX, recommend XXX"Count" -- this is a common convention in Azure
  • see Ted's comments in the APIView
• What does "flaky" mean? Doc comment should describe, or ref to the PlayWright def
  • But don't be afraid of too much explanation
• Maybe "Jobs" -> "JobNames" ... be specific about names vs IDs
  • But be consistent with PlayWright OSS where appropriate
  • and use the description to clarify where needed.
• Use the TypeSpec URL type for things that are URLs
  • And probably call them URL rather than URI
• Spell out acronyms like "ADO"
• Are we sure that 1000 chars is enough for revision URLs?
• Does the Shard model represent a single Shard or multiple?
  • If not a single Shard, probably should be Shards or ShardDetails or ??
• reportedPackageVersion -- will you ever need multiple? Think about that
• createdAt / updatedAt should be UTCDateTime
• Avoid "DTO" in model names
• What is the difference between "annotations" and "tags" ?
  • PlayWright OSS supports both
• "attachmentSize" - see comment in APIView
• "list" should probably have a qualifier to make clear what is being listed

Please address the above and comments in the APIView.
Also need to update to the GA API version.
Then send email requesting final signoff.
We should be able to finish the review async.

[azure-sdk]

Meeting updated by Vansh Singh

Service Name: Playwright-DevDiv-Service - Playwright
Review Created By: Vansh Singh
Review Date: 01/22/2025 09:00 AM PT
Release Plan: 1533
PR: #32020
Hero Scenarios Link: here
Core Concepts Doc Link: here

Description: Microsoft Playwright Testing is an Azure service built on Playwright OSS that allows users to run tests on browsers hosted and managed by the service. It also enables publishing test results and artifacts to the service, which can then be accessed and analyzed through a dashboard.

Detailed meeting information and documents provided can be accessed here
For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here