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 + S360] Review request for Microsoft.SqlVirtualMachine to add version preview/2022-07-01-preview #21564

Conversation

yareyes
Copy link
Member

@yareyes yareyes commented Nov 15, 2022

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

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?

    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify

    Please note we wanted to solve this s360 error: [https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=80337B3E-3B97-47D2-8879-6BCBCCBE59C8] which requires two features to add the default values.

The other changes made were lintDiff errors that broke the code, so adding them.

  1. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  2. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  3. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 15, 2022

Swagger Validation Report

️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.2)] new version base version
sqlvm.json 2022-07-01-preview(967774f) 2022-07-01-preview(main)
Rule Message
1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1693:9
Old: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1654:9
1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1761:9
Old: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1720:9
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) new version base version
package-preview-2022-07 package-preview-2022-07(967774f) package-preview-2022-07(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
ResourceNameRestriction The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L19
ResourceNameRestriction The resource name parameter 'availabilityGroupListenerName' should be defined with a 'pattern' restriction.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L19
ResourceNameRestriction The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L206
OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.SqlVirtualMachine/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L267
ResourceNameRestriction The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L285
LroPatch202 The async patch operation should return 202.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L473
ResourceNameRestriction The resource name parameter 'sqlVirtualMachineGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L570
ResourceNameRestriction The resource name parameter 'sqlVirtualMachineName' should be defined with a 'pattern' restriction.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L652
PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L653
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L684
ResourceNameRestriction The resource name parameter 'sqlVirtualMachineName' should be defined with a 'pattern' restriction.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L696
PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L697
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L728
ResourceNameRestriction The resource name parameter 'sqlVirtualMachineName' should be defined with a 'pattern' restriction.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L740
PatchIdentityProperty The patch operation body parameter schema should contains property 'identity'.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L934
LroPatch202 The async patch operation should return 202.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L950
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1026
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1266
GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1617
GuidUsage Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1635
⚠️ PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'AvailabilityGroupListeners_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema'
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L75
⚠️ XmsLongRunningOperationOptions The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L653
⚠️ XmsLongRunningOperationOptions The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L697
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1041
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1315
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1761
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1790
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1828
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1832
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.SqlVirtualMachine/preview/2022-07-01-preview/sqlvm.json#L1865
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @yareyes Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 15, 2022

    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-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a271823. 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.
      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! 8.19.2 -> 9.1.3
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.3>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-sqlvirtualmachine [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a271823. 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
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/sqlvirtualmachine/armsqlvirtualmachine [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `LeastPrivilegeModeNotSet`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
    ️⚠️ azure-sdk-for-java warning [Detail]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a271823. 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]  WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️sqlvirtualmachine [View full logs]  [Release Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a271823. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.SqlVirtualMachine [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 15, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/sqlvirtualmachine/armsqlvirtualmachine Create ApiView failed. Please ask PR assignee for help
    Python track2_azure-mgmt-sqlvirtualmachine Create ApiView failed. Please ask PR assignee for help
    .Net Azure.ResourceManager.SqlVirtualMachine Create ApiView failed. Please ask PR assignee for help
    Java azure-resourcemanager-sqlvirtualmachine Create ApiView failed. Please ask PR assignee for help

    @openapi-workflow-bot
    Copy link

    Hi @yareyes, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Nov 16, 2022
    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Nov 18, 2022
    @yareyes yareyes changed the title [Hub Generated] Review request for Microsoft.SqlVirtualMachine to add version preview/2022-07-01-preview [S360] Review request for Microsoft.SqlVirtualMachine to add version preview/2022-07-01-preview Nov 18, 2022
    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

    1 similar comment
    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

    @yareyes yareyes changed the title [S360] Review request for Microsoft.SqlVirtualMachine to add version preview/2022-07-01-preview [Hub Generated + S360] Review request for Microsoft.SqlVirtualMachine to add version preview/2022-07-01-preview Nov 21, 2022
    @yareyes yareyes marked this pull request as ready for review November 21, 2022 18:59
    @yareyes
    Copy link
    Member Author

    yareyes commented Nov 22, 2022

    @xiaoxuqi-ms Could you please help me review this PR? Thanks

    @xiaoxuqi-ms
    Copy link
    Member

    Hi @yareyes , please reach out to breaking change review board for the breaking changes first.

    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 30, 2022
    @yareyes
    Copy link
    Member Author

    yareyes commented Nov 30, 2022

    Hello @xiaoxuqi-ms, I've got the approval from breaking change. Can you please help me review this?

    @xiaoxuqi-ms xiaoxuqi-ms merged commit a271823 into Azure:main Dec 1, 2022
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Dec 1, 2022
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    … to add version preview/2022-07-01-preview (Azure#21564)
    
    * Adds base for updating Microsoft.SqlVirtualMachine from version preview/2022-02-01-preview to version 2022-07-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Updating swagger to latest api
    
    * Add default values for optional parameters
    
    * Adding default to optional parameters
    
    * Fixing ModelValidator
    
    * Adding long running options
    
    * Update response to async
    
    * Removing headers
    
    * Adding headers for deletion
    
    * Updating location for Post
    
    * Added prettier check
    
    * Reverted changes from error codes
    
    * Removing the location from POST
    kayousef-zz pushed a commit to kayousef-zz/azure-rest-api-specs that referenced this pull request Dec 21, 2022
    … to add version preview/2022-07-01-preview (Azure#21564)
    
    * Adds base for updating Microsoft.SqlVirtualMachine from version preview/2022-02-01-preview to version 2022-07-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Updating swagger to latest api
    
    * Add default values for optional parameters
    
    * Adding default to optional parameters
    
    * Fixing ModelValidator
    
    * Adding long running options
    
    * Update response to async
    
    * Removing headers
    
    * Adding headers for deletion
    
    * Updating location for Post
    
    * Added prettier check
    
    * Reverted changes from error codes
    
    * Removing the location from POST
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required FixS360 resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants