Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Hub Generated] Review request for Microsoft.PlaywrightTesting to add version preview/2023-10-01-preview #25445

Conversation

mjmadhu
Copy link
Member

@mjmadhu mjmadhu commented Aug 22, 2023

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

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

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

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.

Getting help

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 22, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 22, 2023

Swagger Validation Report

️❌BreakingChange: 14 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
playwrighttesting.json 2023-10-01-preview(417facc) 2023-10-01-preview(main)
Rule Message
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/accounts/{accountId}/access-keys' removed or restructured?
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L94:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/accounts/{accountId}/access-keys/{accessKeyId}' removed or restructured?
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L150:5
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AccessKey' removed or renamed?
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L349:3
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L349:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AccessKeyState' removed or renamed?
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L349:3
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L349:3
1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L431:7
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L428:7
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'accountId' renamed or removed?
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L431:7
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L428:7
1034 - AddedRequiredProperty The new version has new required property 'id' that was not found in the old version.
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L431:7
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L428:7
1034 - AddedRequiredProperty The new version has new required property 'state' that was not found in the old version.
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L431:7
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L428:7
1034 - AddedRequiredProperty The new version has new required property 'subscriptionId' that was not found in the old version.
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L431:7
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L428:7
1034 - AddedRequiredProperty The new version has new required property 'subscriptionState' that was not found in the old version.
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L431:7
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L428:7
1034 - AddedRequiredProperty The new version has new required property 'id, state, subscriptionId, subscriptionState, tenantId' that was not found in the old version.
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L63:13
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L63:13
1034 - AddedRequiredProperty The new version has new required property 'id, state, subscriptionId, subscriptionState, tenantId' that was not found in the old version.
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L428:5
Old: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L425:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L94:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L150:5
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.4) new version base version
package-2023-10-01-preview package-2023-10-01-preview(417facc) default(main)
default default(417facc) default(main)
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
Rule Message
READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST ReadOnly property "dashboardUri" cannot be sent in the request
Url: Microsoft.AzurePlaywrightService/preview/2023-10-01-preview/playwrighttesting.json#L570:25
ExampleUrl: preview/2023-10-01-preview/examples/Accounts_CreateOrUpdate.json#L9:17
READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST ReadOnly property "createdAt" cannot be sent in the request
Url: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L375:22
ExampleUrl: preview/2023-10-01-preview/examples/AccessTokens_CreateAccessToken.json#L8:17
READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST ReadOnly property "createdAt" cannot be sent in the request
Url: Microsoft.PlaywrightTesting.AuthManager/preview/2023-10-01-preview/playwrighttesting.json#L375:22
ExampleUrl: preview/2023-10-01-preview/examples/AccessTokens_CreateAccessToken.json#L8:17
READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST ReadOnly property "dashboardUri" cannot be sent in the request
Url: Microsoft.AzurePlaywrightService/preview/2023-10-01-preview/playwrighttesting.json#L570:25
ExampleUrl: preview/2023-10-01-preview/examples/Accounts_CreateOrUpdate.json#L9:17
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 22, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking



️⚠️ azure-sdk-for-js warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from be4c248. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	No package detected after generation
  • ️✔️@azure/arm-playwrighttesting [View full logs]  [Release SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from be4c248. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/playwrighttesting/resource-manager/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    warn		specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
    warn		specification/playwrighttesting/PlaywrightTesting/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.6.7 -> 10.1.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
    warn	No file changes detected after generation
    warn	No package detected after generation
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from be4c248. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	No package detected after generation
  • ️✔️azure-resourcemanager-playwrighttesting [View full logs]  [Release SDK Changes]
️⚠️ azure-sdk-for-net-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from be4c248. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    warn		specification/playwrighttesting/resource-manager/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    warn		specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml skipped due to azure-sdk-for-net-track2 not found in tspconfig.yaml
    warn		specification/playwrighttesting/PlaywrightTesting/tspconfig.yaml skipped due to azure-sdk-for-net-track2 not found in tspconfig.yaml
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    warn	No file changes detected after generation
    warn	Skip detect changed packages
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from be4c248. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/playwrighttesting/data-plane/readme.md skipped due to azure-sdk-for-python-track2 not found in swagger-to-sdk
    warn		specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
    warn		specification/playwrighttesting/PlaywrightTesting/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]  notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.6.7 -> 10.1.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-playwrighttesting [View full logs]  [Release SDK Changes]
    info	[Changelog]   - Initial Release
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from be4c248. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    warn		specification/playwrighttesting/data-plane/readme.md skipped due to azure-sdk-for-go not found in swagger-to-sdk
    warn		specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
    warn		specification/playwrighttesting/PlaywrightTesting/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/playwrighttesting/armplaywrighttesting [View full logs]  [Release SDK Changes]
    info	[Changelog] This is a new package
    info	[Changelog]
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from be4c248. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    warn		specification/playwrighttesting/data-plane/readme.md skipped due to azure-resource-manager-schemas not found in swagger-to-sdk
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  • ️✔️playwrighttesting [View full logs]  [Release Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from be4c248. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    warn		specification/playwrighttesting/data-plane/readme.md skipped due to azure-powershell not found in swagger-to-sdk
    warn		specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml skipped due to azure-powershell not found in tspconfig.yaml
    warn		specification/playwrighttesting/PlaywrightTesting/tspconfig.yaml skipped due to azure-powershell not found in tspconfig.yaml
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ⚠️Az.playwrighttesting.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.playwrighttesting.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 22, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/playwrighttesting/armplaywrighttesting https://apiview.dev/Assemblies/Review/750e8d38c0064575841efef546e24ef9
JavaScript @azure/arm-playwrighttesting https://apiview.dev/Assemblies/Review/05a6992b12a24d5e871f8cbc47cf7c09
Java azure-resourcemanager-playwrighttesting https://apiview.dev/Assemblies/Review/9065b0a947364cd786afb4fd4e7c54a5

@openapi-workflow-bot
Copy link

Hi @mjmadhu This PR was flagged for introducing a new RP namespace that is not being onboarded with RPaaS. Merging this PR to the main branch will be blocked as RPaaS is required for new RPs. To resolve this and allow the PR to be merged into the main branch, please use RPaaS to onboard the new RP.

@openapi-workflow-bot
Copy link

Hi, @mjmadhu, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved.
Action Required:

  • Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.
  • Paste the issue link that you created in step 1 in this PR

  • Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

    @mjmadhu
    Copy link
    Member Author

    mjmadhu commented Aug 22, 2023

    This PR is for public preview due in September 2023 of an RPaaS RP - Microsoft.AzurePlaywrightService
    Link to SDK namespace approval - Azure/azure-sdk#6473
    Link to private repo - https://github.com/Azure/azure-rest-api-specs-pr/tree/RPSaaSMaster/specification/azureplaywrightservice/resource-manager

    We're intending to move towards better folder and namespace naming convention as discussed with API Stewardship Board and recommended for SDK as well by dropping unnecessary terms from the names like Azure and Service, hence keeping it only as "playwrighttesting".

    Though we'd like to stick to the current RP Namespace "Microsoft.AzurePlaywrightService" for now since our Public preview is due this September and seems like renaming RP Namespace would need sheer updates and re-visits for sign-offs as it seems to be a reset as mentioned here.

    Please let us know if there's any concern with the approach, else we'll fallback to the previous convention of "azureplaywrightservice" for folder structure as well for now.

    Update -
    Had to rename the namespace back to current RP one due to CI Failures - https://github.com/Azure/azure-rest-api-specs/pull/25445/checks?check_run_id=16114492882

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 22, 2023

    Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

    @mjmadhu
    Copy link
    Member Author

    mjmadhu commented Aug 22, 2023

    https://github.com/Azure/azure-rest-api-specs/pull/25445/checks?check_run_id=16114493478
    Swagger Model Validation failing due to known issue where typespec is keeping fields with visibility read as mandatory in the swagger json.
    https://github.com/Azure/typespec-azure/issues/3428 created.

    @mjmadhu
    Copy link
    Member Author

    mjmadhu commented Aug 28, 2023

    Pushing for review by the time the swagger model validation issue is getting fixed for early feedback.

    @AzureRestAPISpecReview

    @mjmadhu mjmadhu marked this pull request as ready for review August 28, 2023 10:28
    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Aug 28, 2023
    @mjmadhu mjmadhu removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review CI-NewRPNamespaceWithoutRPaaS labels Sep 9, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 9, 2023
    @mentat9
    Copy link
    Member

    mentat9 commented Sep 9, 2023

    For my understanding, any reason it's required to have readonly property in PUT payload on example?? They should anyways be optional? @rkmanda @mentat9

    It's not required the properties be in the PUT payload, but it's required that they be allowed in the payload. Hence, they are required in the swagger.

    @mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 9, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 9, 2023
    @mjmadhu
    Copy link
    Member Author

    mjmadhu commented Sep 11, 2023

    /pr RequestMerge

    Copy link
    Member

    @scbedd scbedd left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    The OBJECT_MISSING_REQUIRED_PROPERTY errors are a kafka-trap. If Madhuri fixes them, she'll immediately end up with READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST, which is caused by an outstanding issue with oav.

    When the bug in OAV is fixed, the READONLY_PROPERTY_NOT_ALLOWED_IN_REQUEST with this PR will disappear. Additional work will be necessary to update the OBJECT_MISSING_REQUIRED_PROPERTY issues.

    @mjmadhu
    Copy link
    Member Author

    mjmadhu commented Sep 12, 2023

    /pr RequestMerge

    @rkmanda rkmanda merged commit be4c248 into main Sep 12, 2023
    @rkmanda rkmanda deleted the mjmadhu-playwrighttesting-Microsoft.AzurePlaywrightService-2023-10-01-preview branch September 12, 2023 18:59
    @openapi-pipeline-app
    Copy link

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
    … version preview/2023-10-01-preview (#25445)
    
    * Generate new Service for playwrighttesting
    
    * Adding Management APIs for Microsoft.AzurePlaywrightService public preview api-version 2023-10-01-preview
    
    * CI failures Fix
    
    * Removed description form properties as it's not required
    
    * Added new resource type
    
    * Spell check fix
    
    * Renamed quota resource type
    
    * Rectifying the typespec issue for location based resource
    
    * Renamed enum value
    
    * Review comments addressed
    
    * Swagger build errors resolution
    
    * Swagger model validation error fix for example
    
    * Added dashboard URI in examples
    
    * Revert "Added dashboard URI in examples"
    
    This reverts commit 8b1a7cb.
    
    * Mjmadhu playwrighttesting microsoft.azure playwright service 2023 10 01 preview data plane (#25681)
    
    * Renamed entity from access-key to access-token
    
    * Added subscription state to handle appropriate action for clients
    
    * Added account state as a property
    
    * Updated regex for names
    
    * Updated example
    
    * Added readonly properties in PUT request examples
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-ModelValidation ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane new-api-version new-rp-namespace resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    9 participants