-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Create new version 2022-09-30-preview for MySQL #23276
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
Conversation
|
Hi, @xiaoxuqi-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
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| Configurations.json | 2021-12-01-preview(01e3f23) | 2021-12-01-preview(main) |
| common-types.json | 2022-09-30-preview(01e3f23) | 2022-09-30-preview(main) |
️❌Breaking Change(Cross-Version): 1 Errors, 16 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| Backups.json | 2022-09-30-preview(01e3f23) | 2022-01-01(main) |
| Backups.json | 2022-09-30-preview(01e3f23) | 2021-12-01-preview(main) |
| FlexibleServers.json | 2022-09-30-preview(01e3f23) | 2022-01-01(main) |
| FlexibleServers.json | 2022-09-30-preview(01e3f23) | 2021-12-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
1047 - XmsEnumChanged |
The new version has a different x-ms-enum 'modelAsString' than the previous one. New: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L1184:9 Old: FlexibleServers/stable/2022-01-01/FlexibleServers.json#L1104:9 |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 1 Errors, 15 Warnings failed [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-flexibleserver-2022-09-30-preview-privatelink | package-flexibleserver-2022-09-30-preview-privatelink(01e3f23) | package-flexibleserver-2022-09-30-preview-privatelink(main) |
| package-flexibleserver-2022-09-30-preview | package-flexibleserver-2022-09-30-preview(01e3f23) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L554 |
RPC-Async-V1-11 |
| OperationId should contain the verb: 'backupandexport' in:'BackupAndExport_Create'. Consider updating the operationId Location: Backups/preview/2022-09-30-preview/BackupAndExport.json#L29 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Backups/preview/2022-09-30-preview/BackupAndExport.json#L36 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Backups/preview/2022-09-30-preview/BackupAndExport.json#L104 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L58 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L128 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L186 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L241 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L283 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L325 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L364 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L412 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L469 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L517 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L565 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L625 |
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 'serverName' should be defined with a 'pattern' restriction. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L37 |
ResourceNameRestriction |
The resource name parameter 'configurationName' should be defined with a 'pattern' restriction. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L37 |
ResourceNameRestriction |
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L37 |
ResourceNameRestriction |
The resource name parameter 'configurationName' should be defined with a 'pattern' restriction. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L37 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Configurations/preview/2021-12-01-preview/Configurations.json#L38 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Configurations/preview/2021-12-01-preview/Configurations.json#L38 |
LongRunningResponseStatusCode |
A 'put' operation 'Configurations_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L38 |
LongRunningResponseStatusCode |
A 'put' operation 'Configurations_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L38 |
CreateOperationAsyncResponseValidation |
An async PUT operation must return 201. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L75 |
CreateOperationAsyncResponseValidation |
An async PUT operation must return 201. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L75 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L82 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L82 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L126 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L126 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L126 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L126 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L143 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L143 |
ResourceNameRestriction |
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L199 |
ResourceNameRestriction |
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L199 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Configurations/preview/2021-12-01-preview/Configurations.json#L200 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Configurations/preview/2021-12-01-preview/Configurations.json#L200 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L241 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L241 |
ResourceNameRestriction |
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L257 |
ResourceNameRestriction |
The resource name parameter 'serverName' should be defined with a 'pattern' restriction. Location: Configurations/preview/2021-12-01-preview/Configurations.json#L257 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L38 |
LongRunningResponseStatusCode |
A 'put' operation 'Servers_Create' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L38 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L94 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json#L175 |
️❌Avocado: 1 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
MULTIPLE_DEFAULT_TAGS |
The readme file has more than one default tag. readme: specification/mysql/resource-manager/readme.md |
| 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]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi, @xiaoxuqi-ms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
Hi @xiaoxuqi-ms, 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. |
|
Hi @xiaoxuqi-ms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @xiaoxuqi-ms, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
|
Signing off, please make sure to open a track item for next version to fix the 202 |
…-rest-api-specs into mysql20220930preview
|
I cannot find a proper diff on 2022-09-30-preview/FlexibleServers.json via commit history, could you provide one for easy to review on what is changed compared to previous preview? Also you need to fix Avocado. |
* add base folder 2022-09-30-preview from 2021-12-01-preview * update version and add new file backupandexport.json * update readme * add common-types * fix readme * copy 2021-12-01-preview folder to init 2022-09-30-preview * update version, readme and add new api in FlexibleServers.json * fix spell check * fix linter * fix linter * fix linter for flexible server * add location in header to fix linter * add base for serviceoperation * update api version * add new api for service operation * update readme * fix model validation * fix prettier * update to v5 for apiVersionParameter and resourceGroupName * fix linter * fix lro errorResponse * enableScaling and revert configuration * fix enableStatusEnum * sync backupExport * update readme * remove service operation * update backups * udpate backup name * fix final-state-via * fix lro option * revert replication role * use cloudError * Update readme.python.md * fix customer word * add default value for EnableStatusEnum * add logondisk * fix description --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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.