Add MySQL Flex API Version 2021-12-01-preview #19217
Closed
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 |
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). |
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 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: resetAllToDefault Location: Microsoft.DBforMySQL/preview/2021-12-01-preview/Configurations.json#L410 |
|
| 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
|
|
Hi @zehao-ms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced May 25, 2022
Closed
openapi-pipeline-app
bot
removed
CI-FixRequiredOnFailure
CI-BreakingChange-Go-V2
labels
raosuhas
reviewed
Jun 7, 2022
| "$ref": "#/definitions/Server" | ||
| } | ||
| }, | ||
| "202": { |
There was a problem hiding this comment.
we dont use the 202 model for PUTs anymore :
There was a problem hiding this comment.
This is a legacy API copied from previous API version.
raosuhas
reviewed
Jun 7, 2022
.../mysql/resource-manager/Microsoft.DBforMySQL/preview/2021-12-01-preview/FlexibleServers.json
Outdated
Show resolved
Hide resolved
raosuhas
reviewed
Jun 7, 2022
| "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" |
There was a problem hiding this comment.
Copied from previous API version
raosuhas
reviewed
Jun 7, 2022
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK", |
There was a problem hiding this comment.
Copied from previous API version
raosuhas
reviewed
Jun 7, 2022
| } | ||
| ], | ||
| "responses": { | ||
| "200": { |
There was a problem hiding this comment.
Same comment everywhere else in this PR
There was a problem hiding this comment.
Copied from previous API version
raosuhas
reviewed
Jun 7, 2022
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/ServerListResult" |
There was a problem hiding this comment.
Is there only list for the replicas ? What about point Gets \Puts\Deletes for this resource ? How is it created etc ?
There was a problem hiding this comment.
Copied from previous API version.
The replica is a kind of special server. They are created by creating server API with parameters, so there is only list for this.
raosuhas
reviewed
Jun 7, 2022
| "description": "Maintenance window of a server.", | ||
| "properties": { | ||
| "customWindow": { | ||
| "type": "string", |
There was a problem hiding this comment.
Copied from previous API version.
raosuhas
reviewed
Jun 7, 2022
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "The name of the sku, e.g. Standard_D32s_v3." |
There was a problem hiding this comment.
Copied from previous API version.
raosuhas
reviewed
Jun 7, 2022
| "description": "Delegated subnet resource id used to setup vnet for a server." | ||
| }, | ||
| "privateDnsZoneResourceId": { | ||
| "type": "string", |
There was a problem hiding this comment.
Consider adding linked access checks where appropriate :
https://armwiki.azurewebsites.net/authorization/RBACLinkedAccessCheck.html?q=Linked%20access%20check
There was a problem hiding this comment.
Copied from previous API version.
raosuhas
reviewed
Jun 7, 2022
| }, | ||
| "description": "Server restart parameters." | ||
| }, | ||
| "Identity": { |
There was a problem hiding this comment.
Copied from previous API version.
raosuhas
reviewed
Jun 7, 2022
| } | ||
| }, | ||
| "description": "List all the backups for a given server.", | ||
| "parameters": [ |
There was a problem hiding this comment.
this is a point GET so should only return one baackup
raosuhas
reviewed
Jun 7, 2022
| }, | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/backups/{backupName}": { | ||
| "put": { |
There was a problem hiding this comment.
Copied from previous API version.
Yes, currently backups are managed by service and cannot be deleted by customer.
raosuhas
reviewed
Jun 7, 2022
| "ServerBackupProperties": { | ||
| "type": "object", | ||
| "properties": { | ||
| "backupType": { |
There was a problem hiding this comment.
Copied from previous API version.
raosuhas
reviewed
Jun 7, 2022
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/updateConfigurations": { | ||
| "post": { |
There was a problem hiding this comment.
can you explain a bit about how this confguration object works ?
Does this post operation create the configurations/{configurationName} resource ?
I see that the configurations/{configurationName} does not support PUT so how is it created ?
Note it is not recommended to use POST to create resources since this would not enable creation via ARM templates and application of Azure Policy
There was a problem hiding this comment.
Copied from previous API version.
These configurations are a set of parameters of MySQL itself.
The service exposes some parameters to customer for modifying and there is no resource created on this.
raosuhas
reviewed
Jun 7, 2022
| }, | ||
| { | ||
| "$ref": "#/parameters/ConfigurationPageSizeParameter" | ||
| } |
There was a problem hiding this comment.
I dont see where these params are being used ?
There was a problem hiding this comment.
They are used in Configurations_ListByServer
raosuhas
reviewed
Jun 7, 2022
| } | ||
| }, | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/flexibleServers/{serverName}/logFiles": { |
There was a problem hiding this comment.
A legacy API in previous version.
Logfiles are some logs generated by service program on backend. They are managed by service, so there is no PUT/DELETE
raosuhas
reviewed
Jun 7, 2022
| }, | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/capabilities": { | ||
| "get": { |
There was a problem hiding this comment.
Copied from previous API version.
raosuhas
reviewed
Jun 8, 2022
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkVirtualNetworkSubnetUsage": { |
There was a problem hiding this comment.
Copied from previous API version.
The virtualNetwork here should mean the Vnet related settings on this server.
raosuhas
reviewed
Jun 8, 2022
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/checkNameAvailability": { |
There was a problem hiding this comment.
Copied from previous API version.
raosuhas
added
ARMChangesRequested
zizw123
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
@zehao-ms I see a lot of comments saying it's copied from previous version, but in the change I don't see the reference for the previous version. Can you make sure you put the previous version in the first commit so we can use it view the diff? This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version |
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
|
Open a new PR by openAPI hub: |
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
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.
Please follow the link to find more details on PR review process.