Add swagger files for api-version 2021-05-01-preview of MySQL flexible server #14986
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
|
Hi, @Suna-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. vsswagger@microsoft.com |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
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-05-01-preview/mysql.json#L1148 |
|
| 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-05-01-preview/mysql.json#L1293 |
|
| OperationId should contain the verb: 'updateconfigurations' in:'Configurations_BatchUpdate'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json#L1148 |
|
| OperationId should contain the verb: 'checkvirtualnetworksubnetusage' in:'CheckVirtualNetworkSubnetUsage_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json#L1293 |
|
| OperationId should contain the verb: 'checknameavailability' in:'CheckNameAvailability_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json#L1341 |
|
| OperationId should contain the verb: 'getprivatednszonesuffix' in:'GetPrivateDnsZoneSuffix_Execute'. Consider updating the operationId Location: Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json#L1389 |
|
| 'identity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: common-types/resource-management/v1/types.json#L163 |
|
| 'sku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: common-types/resource-management/v1/types.json#L170 |
|
| 'plan' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: common-types/resource-management/v1/types.json#L177 |
|
| 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-05-01-preview/mysql.json#L377 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DBforMySQL/preview/2021-05-01-preview/mysql.json#L2538 |
| 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-05-01-preview/mysql.json#L2461 |
️⚠️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 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 64 Errors, 38 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:preview/2021-05-01-preview/mysql.json compared with base:preview/2020-07-01-privatepreview/mysql.json
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L37:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L247:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.DBForMySql/flexibleServers' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L289:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/restart' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L328:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/start' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L371:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/stop' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L414:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/replicas' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L457:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys/{keyName}' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L502:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/keys' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L656:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForMySql/flexibleServers/{serverName}/firewallRules/{firewallRuleName}' removed or restructured? Old: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json#L701:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"mysql/resource-manager/readme.md",
"tag":"package-flexibleserver-2021-05-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"mysql/resource-manager/readme.md",
"tag":"package-flexibleserver-2021-05-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"mysql/resource-manager/readme.md",
"tag":"package-flexibleserver-2021-05-01-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
This was referenced Jun 25, 2021
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @Suna-MS your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
This was referenced Jun 25, 2021
Suna-MS
requested review from
00Kai0,
ArcturusZhang,
jsntcy,
msyyc and
RAY-316
as code owners
pilor
reviewed
Jun 29, 2021
| "properties": { | ||
| "publicNetworkAccess": { | ||
| "$ref": "#/definitions/EnableStatusEnum", | ||
| "readOnly": true, |
There was a problem hiding this comment.
why is this readonly? The description implies it is settable and the contract for publicNetworkAccess typically has this settable
There was a problem hiding this comment.
In our design, the property of publicNetworkAccess is not settable, its value depends on if delegatedSubnetResourceId is provided or not when creating a server. If delegatedSubnetResourceId is provided in request body, the value of publicNetworkAccess will be Disabled (server can only be accessed via vnet), else it is Enabled.
"network": {
"delegatedSubnetResourceId": "xxxxx"
}
There was a problem hiding this comment.
Please update the description of this property to reflect that
There was a problem hiding this comment.
updated in new commit
pilor
added
the
ARMChangesRequested
pilor
added
ARMSignedOff
weidongxu-microsoft
approved these changes
Jul 1, 2021
Comment on lines
1796
to
1800
| "tags": { | ||
| "type": "object", | ||
| "additionalProperties": { | ||
| "type": "string" | ||
| }, |
There was a problem hiding this comment.
TrackedResource already defined tags. This appears to be the cause of validation and golang failure.
There was a problem hiding this comment.
thanks, removed tags in new commit.
weidongxu-microsoft
added
the
Approved-OkToMerge
|
Hi, @weidongxu-microsoft , could you please help merge this pull request? |
|
Ignore tie Cross-Version Breaking Changes as this flexible server is totally different API than previous postgresql tag. |
This was referenced Jul 9, 2021
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…e server (Azure#14986) * Add swagger files for api-version 2021-05-01-preview of MySQL flexible server * fix provider namespace case sensitive * Fix Swagger LintDiff failures * Rename tag name in readme and improve swagger spec * Remove tags from server definition
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.
…e server
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.