[2022-05-01] Database ARM API swagger changes for vbs enclaves#20413
Merged
xiaoxuqi-ms merged 2 commits intoAzure:dev-sql-Microsoft.Sql-2022-05-01-previewfrom Sep 3, 2022
Conversation
|
Hi, @vidit-msft 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.9.7)] | new version | base version |
|---|---|---|
| Databases.json | 2022-05-01-preview(d19ed3f) | 2021-11-01(main) |
| Databases.json | 2022-05-01-preview(d19ed3f) | 2022-02-01-preview(main) |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-05 | package-preview-2022-05(d19ed3f) | package-preview-2022-05(dev-sql-Microsoft.Sql-2022-05-01-preview) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Missing identifier id in array item property Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L1833 |
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L325 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L445 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L555 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L605 |
|
| OperationId should contain the verb: 'move' in:'Databases_Rename'. Consider updating the operationId Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L509 |
|
| '$skipToken' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L33 |
|
| The response of operation:'Databases_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L71 |
|
| The response of operation:'Databases_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L117 |
|
| The response of operation:'Databases_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2022-05-01-preview/Databases.json#L265 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/sql/resource-manager/readme.md tag: specification/sql/resource-manager/readme.md#tag-package-composite-v5 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/d19ed3f0af7405b04e41b1054c54dd499233fda5/specification/sql/resource-manager/readme.md#tag-package-preview-2022-05">sql/resource-manager/readme.md#package-preview-2022-05
| Rule | Message |
|---|---|
|
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Duplicate Operation 'DatabaseSqlVulnerabilityAssessmentBaselines' > 'CreateOrUpdate' detected(This is most likely due to 2 operation using the same 'operationId' or 'tags'). Duplicates have those paths:\n - put /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Sql/servers/serverName/databases/databaseName/sqlVulnerabilityAssessments/vulnerabilityAssessmentName/baselines/baselineName\n - put /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Sql/servers/serverName/sqlVulnerabilityAssessments/vulnerabilityAssessmentName/baselines/baselineName" |
|
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Duplicate Operation 'DatabaseSqlVulnerabilityAssessmentRuleBaselines' > 'Delete' detected(This is most likely due to 2 operation using the same 'operationId' or 'tags'). Duplicates have those paths:\n - delete /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Sql/servers/serverName/databases/databaseName/sqlVulnerabilityAssessments/vulnerabilityAssessmentName/baselines/baselineName/rules/ruleId\n - delete /subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.Sql/servers/serverName/sqlVulnerabilityAssessments/vulnerabilityAssessmentName/baselines/baselineName/rules/ruleId" |
|
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Duplicate object schemas with 'SecurityAlertPolicyName' name detected." |
|
"readme":"sql/resource-manager/readme.md", "tag":"package-preview-2022-05", "details":"Error: 3 errors occured -- cannot continue." |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
vidit-msft
changed the title
|
Hi @vidit-msft, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Aug 26, 2022
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @vidit-msft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Member
|
Add new parameters in a new API version. do we need an ARM reviewer sign off? We want to get ARM reviewer to confirm. |
raosuhas
added
ARMSignedOff
ericshape
approved these changes
Sep 2, 2022
Member
ericshape
left a comment
ericshape
left a comment
There was a problem hiding this comment.
LGTM.
Please add the missing example reference.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
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.