Adding new Virtual Cluster APIs #20469
Merged
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, @toki95 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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| VirtualClusters.json | 2022-05-01-preview(3dccf78) | 2021-11-01(main) |
| VirtualClusters.json | 2022-05-01-preview(3dccf78) | 2022-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version adds a response code '202'. New: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L255:11 |
|
The new version is missing a property found in the old version. Was 'family' renamed or removed? New: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L346:7 Old: Microsoft.Sql/stable/2021-11-01/VirtualClusters.json#L337:7 |
|
The new version is missing a property found in the old version. Was 'maintenanceConfigurationId' renamed or removed? New: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L346:7 Old: Microsoft.Sql/stable/2021-11-01/VirtualClusters.json#L337:7 |
|
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L225:7 Old: Microsoft.Sql/stable/2021-11-01/VirtualClusters.json#L225:7 |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version adds a response code '202'. New: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L255:11 |
|
| The new version is missing a property found in the old version. Was 'family' renamed or removed? New: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L346:7 Old: Microsoft.Sql/preview/2022-02-01-preview/VirtualClusters.json#L337:7 |
|
| The new version is missing a property found in the old version. Was 'maintenanceConfigurationId' renamed or removed? New: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L346:7 Old: Microsoft.Sql/preview/2022-02-01-preview/VirtualClusters.json#L337:7 |
|
| The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L225:7 Old: Microsoft.Sql/preview/2022-02-01-preview/VirtualClusters.json#L225:7 |
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-05 | package-preview-2022-05(3dccf78) | package-preview-2022-05(dev-sql-Microsoft.Sql-2022-05-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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/VirtualClusters.json#L224 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| OperationId should contain the verb: 'updatemanagedinstancednsservers' in:'VirtualClusters_UpdateDnsServers'. Consider updating the operationId Location: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L230 |
|
| The response of operation:'VirtualClusters_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L95 |
|
| The response of operation:'VirtualClusters_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2022-05-01-preview/VirtualClusters.json#L173 |
️⚠️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/3dccf7838c109cb349a2c0f600e11a02ecaaa6bc/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
|
Hi @toki95, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Aug 30, 2022
Closed
This was referenced Aug 30, 2022
added 2 commits
August 30, 2022 12:12
|
Hi @toki95, 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. |
|
@xiaoxuqi-ms @raych1 |
|
@toki95 can you address the breaking change pipeline? Is it expected? If yes, we need to get ARM breaking change reviewer sign-off. |
Yes, all breaking changes introduced here are intentional. |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @toki95 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
|
Changes look fine from ARM perspective. Can you please get the signoff from the breaking change board. |
This is newly added and currently, it is not a required check. But it will be a required check |
raosuhas
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
|
Please remove the ARMCHangesRequested label once the breaking change is approved |
JeffreyRichter
added
the
Approved-BreakingChange
ericshape
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
ericshape
approved these changes
Sep 2, 2022
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
xiaoxuqi-ms
approved these changes
Sep 3, 2022
ericshape
added a commit
to ericshape/azure-rest-api-specs
that referenced
this pull request
Sep 15, 2022
[2022-05-01] Update parameter name of Database ARM API swagger changes for vbs enclaves (Azure#20606) * swagger changes for vbs enclaves * remove unreferenced json example * update name of parameter from enclaveType -> preferredEnclaveType * name change fix * fix json * added examples for update database with enclave type * add missing example file * fix spell check [2022-05-01] Database ARM API swagger changes for vbs enclaves (Azure#20413) * swagger changes for vbs enclaves * remove unreferenced json example Adding new Virtual Cluster APIs (Azure#20469) * adding new VC VNext APIs * fixing examples * fixing examples2 * doing this to kick of validation that's stuck * doing this to kick of validation that's stuck * removing not neede file Co-authored-by: Jovana Toroman <[email protected]> swagger and example files for new api GetSynapselinkWorkspaces (Azure#20377) * swagger and example files for new api * Update readme.md * Update custom-words.txt * Update GetSynapseLinkWorkspaces.json Fix databaseName spelling. * Update SynapseLinkWorkspaces.json regenerate swagger to fix spelling. * Update readme.md add to v5 package * update example file * Update GetSynapseLinkWorkspaces.json empty properties * Update SynapseLinkWorkspaces.json Use TrackedResource * Update SynapseLinkWorkspaces.json revert tracked resource * Update SynapseLinkWorkspaces.json * Update GetSynapseLinkWorkspaces.json only for testing. * Update GetSynapseLinkWorkspaces.json add properties back * Update GetSynapseLinkWorkspaces.json remove properties for testing only. * Update GetSynapseLinkWorkspaces.json add value to example file. * Update SynapseLinkWorkspaces.json add x-ms-identifier * Update GetSynapseLinkWorkspaces.json fix prettier text * remove get and use listbydatbases remove get and use listbydatbases * fix path of example file. fix path of example file. * Update SynapseLinkWorkspaces.json added new error codes. Added new DTC api version in V2022-05-01-preview (Azure#20395) * Added new examples and swagger for managed instance DTC * Fixed examples * Fixed examples typo, and added newer version to package composite v5 readme * Changed error messages and updated parameter descriptions Co-authored-by: Stefan Krivokapic <[email protected]> [SQL] 2022-05-01 DistributedAvailabilityGroups SetRole specs (Azure#20321) * Add DAG setRole swag docs * regenerate files * regenerate files * bump v5 tag * Update specification/sql/resource-manager/readme.md * Minor fix - update descriptions MI standby replica (Azure#20237) * Update InstanceFailoverGroups * Regenerate swagger Co-authored-by: Lazar Lazic <[email protected]> Managed Instance Long Term Retention Policy v20220501 (Azure#20099) * aupdate swagger files * fix validation break * fix validation error again * fix validation v3 ManagedDatabases 2022-05-01-preview update: ManagedDatabaseStatus (Azure#20114) * ManagedDatabases 2022-05-01-preview update: ManagedDatabaseStatus * Add Swaggers for API versions < 20220501 * Revert "Add Swaggers for API versions < 20220501" This reverts commit e3d4879. * Regenerate Swagger after the latest API changes * Regenerate Swagger after reverting the SwaggerEnum-name to "ManagedDatabaseStatus" Co-authored-by: Djordje Jeremic <[email protected]> ManagedDatabaseMoveOperations: Initial commit (Azure#20066) * ManagedDatabaseMoveOperations: Initial commit * fixup! ManagedDatabaseMoveOperations: Initial commit Co-authored-by: Djordje Jeremic <[email protected]> Added new managed database swagger and example (Azure#19954) Create dev branch dev-sql-Microsoft.Sql-2022-05-01-preview (Azure#19915) * Adds base for updating Microsoft.Sql from version preview/2022-02-01-preview to version 2022-05-01-preview * Updates readme * Updates API version in new specs and examples * revert the default tag
11 tasks
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.
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.