[Hub Generated] Review request for Microsoft.DBforMySQL to add version preview/2021-12-01-preview #19454
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zehao-ms
requested review from
msyyc,
BigCat20196 and
ArcturusZhang
as code owners
|
Hi, @zehao-ms Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Since operation 'Configurations_BatchUpdate' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L143 |
|
| Since operation 'CheckVirtualNetworkSubnetUsage_Execute' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L84 |
|
| 'PUT' operation 'Backups_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Backups.json#L42 |
|
| OperationId should contain the verb: 'updateconfigurations' in:'Configurations_BatchUpdate'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L143 |
|
| OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'CheckVirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L84 |
|
| OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L132 |
|
| OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L180 |
|
| The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/FlexibleServers.json#L1080 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Restart a server Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/FlexibleServers.json#L383 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json#L491 |
|
| The resource 'LogFile' does not have get operation, please add it. Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/LogFiles.json#L113 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/mysql/resource-manager/readme.md tag: specification/mysql/resource-manager/readme.md#tag-package-2020-01-01 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️Cross-Version Breaking Changes: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| "details":"Attention: There are some existing APIs currently documented in a new spec file. The validation may not be able to report breaking changes with these APIs. It is recommended not to rename swagger file or move public APIs to a new file when creating a new API version.The existing APIs being moved are:Operations_List;", "location":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-12-01-preview/ServiceOperations.json" |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
This was referenced Jun 15, 2022
|
This is a new PR made by openAPI hub for review. |
|
Hi @zizw123 , could you please help review this PR? thanks |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @zehao-ms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
25 tasks
zizw123
reviewed
Jun 15, 2022
| }, | ||
| "description": "The list of server configurations." | ||
| }, | ||
| "resetAllToDefault": { |
There was a problem hiding this comment.
Consider using enum over boolean: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html?q=boolean#common-issues-found-in-review
zizw123
reviewed
Jun 15, 2022
| "description": "The properties of a logFile." | ||
| }, | ||
| "systemData": { | ||
| "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", |
There was a problem hiding this comment.
There was a problem hiding this comment.
Thank you @zizw123 , I tried to modify version to v3, but get some strange errors in pipline about lintdiff and sdk-for-go:
"location":"specification/mysql/resource-manager/readme.md",
"tag":"package-flexibleserver-2021-12-01-preview",
"details":"Error: '$.definitions.Sku.properties.name.description' has incompatible values (---'The name of the sku,
e.g. Standard_D32s_v3.',
---The name of the SKU. Ex - P3. It is typically a letter+number code)."
The error message was so confusing and I tried several ways to fix this but failed. In the end I changed these back to v2, making the pipline successful.
There was a problem hiding this comment.
You should really look into these and make the updates when possible, for now, will let it go.
zizw123
reviewed
Jun 15, 2022
| }, | ||
| "allOf": [ | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" |
There was a problem hiding this comment.
|
Added some comments for the new changes added besides the split. |
zizw123
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
Hi @zehao-ms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
zehao-ms
force-pushed
the
dev-mysql-Microsoft.DBforMySQL-2021-12-01-preview
branch
from
773f6ff to
a5023cf
Compare
zehao-ms
force-pushed
the
dev-mysql-Microsoft.DBforMySQL-2021-12-01-preview
branch
from
9ea04ac to
a5023cf
Compare
zehao-ms
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
zizw123
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
Thank you @zizw123. |
leni-msft
approved these changes
Jun 17, 2022
This was referenced Jun 17, 2022
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jun 17, 2022
…ySQL to add version preview/2021-12-01-preview (#2427) Create to sync Azure/azure-rest-api-specs#19454 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/mysql?expand=1)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.