[Playwright-DevDiv-Service - Playwright] API Review

[azure-sdk]

New API Review meeting has been requested.

Service Name: Playwright-DevDiv-Service - Playwright
Review Created By: Abhishek Ranjan
Review Date: 07/11/2024 08:00 AM PT
Release Plan: 1346
PR:
Hero Scenarios Link: here
Core Concepts Doc Link: here

Description: Playwright Data Plane API service review for Reporting feature

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 Abhishek Ranjan

Service Name: Playwright-DevDiv-Service - Playwright
Review Created By: Abhishek Ranjan
Review Date: 07/11/2024 08:00 AM PT
Release Plan: 1346
PR:
Hero Scenarios Link: here
Core Concepts Doc Link: here

Description: Playwright Data Plane API service review for Reporting feature- https://github.com/Azure/azure-rest-api-specs-pr/pull/18793/

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 Abhishek Ranjan

Service Name: Playwright-DevDiv-Service - Playwright
Review Created By: Abhishek Ranjan
Review Date: 07/11/2024 08:00 AM PT
Release Plan: 1346
PR:
Hero Scenarios Link: here
Core Concepts Doc Link: here

Description: Playwright Data Plane API service review for Reporting feature- https://github.com/Azure/azure-rest-api-specs-pr/pull/18819

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 meeting 7/11/24

• Recommend to split the TypeSpec into separate files for easier review
• To link your examples into the TypeSpec, add an operationId in the example
• Recommend to use block comment style (/**) in place of @doc
• startTIme should be defined as UtcDateTime
• How to modify the description of the filter parameter? Use the "augment" decorator, @@doc(Target, "xxx")
• Don't use @visibility("read") on properties that are only in responses
• Consider naming "TestRunSummary" and "TestRunResultsSummary" -- current names are too similar
  • Also "TestResultsSummary" ! Oh my!
• Need to fix the path test-results-summary/summary. Post in the TypeSpec discussions channel and someone there will help you.

Let's work these offline and once resolved this looks good for preview.