Update swagger documentation for Managed Instance start-stop actions #22992
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, @ilijadivljan-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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| ManagedInstances.json | 2022-11-01-preview(64f0067) | 2021-11-01(main) |
| ManagedInstances.json | 2022-11-01-preview(64f0067) | 2022-08-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version adds a x-ms-enum extension. New: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L898:9 Old: Microsoft.Sql/stable/2021-11-01/ManagedInstances.json#L806:9 |
The following breaking changes are detected by comparison with the latest preview version:
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(64f0067) | package-preview-2022-11(release-sql-Microsoft.Sql-2022-11-01-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'instancePoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L65 |
|
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L170 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L218 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L257 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L257 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L277 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L304 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L357 |
|
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L375 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L376 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L422 |
|
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L434 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'ManagedInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L440 |
|
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L476 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L507 |
|
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L522 |
|
A 202 response should include an Location response header. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L553 |
|
The resource name parameter 'managedInstanceName' should be defined with a 'pattern' restriction. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L568 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'ManagedInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L574 |
|
Missing identifier id in array item property Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L1253 |
|
Missing identifier id in array item property Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L1353 |
|
Missing identifier id in array item property Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L1437 |
|
Missing identifier id in array item property Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L1450 |
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L26 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L72 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L128 |
|
| The response of operation:'ManagedInstances_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L171 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L177 |
|
| The response of operation:'ManagedInstances_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L218 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.Sql/preview/2022-11-01-preview/ManagedInstances.json#L218 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
ghost
added
the
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @ilijadivljan-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. |
This was referenced Mar 9, 2023
|
@raych1 These breaking changes are unrelated to this Pull Request. They are related to the previous one which was signed off by Jeffery.
|
mmaricic-microsoft
approved these changes
Mar 9, 2023
|
@jamestao @ericshape can you take a look at this PR today as March 10th is cutoff date for this API version? |
ericshape
approved these changes
Mar 9, 2023
raych1
added
the
Approved-BreakingChange
|
The breaking change isn't introduced by this PR. |
ilijadivljan-ms
deleted the
dev/ilijadivljan/update-managed-instance-start-stop-response-codes
branch
raych1
pushed a commit
that referenced
this pull request
May 19, 2023
* Adds base for updating Microsoft.Sql from version preview/2022-08-01-preview to version 2022-11-01-preview * Updates readme * Updates API version in new specs and examples * Add Swagger API changes required for progress-reporting related changes in DatabaseOperations (#22669) * Update swagger (#22715) * Follow-up Swagger API changes required for progress-reporting related changes in DatabaseOperations (#22775) * Add Swagger API changes required for progress-reporting related changes in DatabaseOperations * Follow up changes required for progress-reporting related changes in DatabaseOperations * updated example file * Added Failed case in list-operations examples * Update Microsoft.Sql ManagedInstance 2022-11-01-preview Swagger Docs (#22899) * Update Microsoft.sql ManagedInstance 2022-11-01-preview Swagger Docs * Address Swagger Validation Errors * Modify custom-words.txt * Manually updating arm-id format to match stable 2021-11-01 version * Adding provisioning state changes * fixing validation * adding missing space * Remove HTTP 200 from Start/Stop Actions as we only return HTTP 202 --------- Co-authored-by: Jovana Toroman <[email protected]> * Update DateTime to ISO-8601 format in example file (#22986) * Add Swagger API changes required for progress-reporting related changes in DatabaseOperations * Follow up changes required for progress-reporting related changes in DatabaseOperations * updated example file * Added Failed case in list-operations examples * Update DateTime to ISo-8601 format in example file * Enable TryPlannedBeforeForcedFailover for SQL DB Failover Group (#22673) * Enable TryPlannedBeforeForcedFailover for SQL DB Failover Group * Modify example file * Add example * Fix ModelValidation issues * Fix ModelValidation issues * Add new controller * Modify example * Modify example * Update server name * Fix LintDiff * Fix model validation errors * Fix PostOperationAsyncResponseValidation, Unfix LroLocationHeader,ResourceNameRestriction * Fix PostOperationAsyncResponseValidation * Fix pending items * Update doc * Remove empty/unschematized object --------- Co-authored-by: subhrob <[email protected]> * [DO NOT MERGE] Add Archive option to LTR Policy for SQL DB (#22697) * add archival changes to LTRPolicy * fix LongTermRetentionPolicies swagger file * fix check failures * redo swagger * Update swagger documentation for Managed Instance start-stop actions (#22992) * Add NetworkSecurityPerimeterConfigurations Swagger (#22960) * Add NetworkSecurityPerimeterConfigurations Swagger * Fixes round 1 * Fixes round 2 * Fixes Round 3 * Fixes Round 4 * Fix Round 5 * fixing enum (#22995) Co-authored-by: Jovana Toroman <[email protected]> * add changes (#23120) * Carry all minor changes to dev sql microsoft.sql 2022 11 01 preview (#23337) * Revert "add changes (#23120)" This reverts commit 5c348d2. Revert "[DO NOT MERGE] Add Archive option to LTR Policy for SQL DB (#22697)" This reverts commit 559f7f4. * Carrying minor changes to release branch for Microsoft.Sql 2022-11-01-preview * Reverting DatabaseAdvisors * Further reverting problematic files * Reverting a few example files * Adding back arm-id to a few files * Reverting error message change in ManagedDatabaseRestoreDetails.json, Jobs.json,ServerDevOpsAudit.json, and TransparentDataEncryptions.json * Minor fixes for Turkey name change and missing x-ms-identifier (#23637) * Fixing issues with a few breaking changes (#23943) * Minor fixes for Turkey name change and missing x-ms-identifier * Adding back missing arm-id and other missing property issues causing breaking changes incorrectly. * Fixing prettier issue with ManagedDatabases.json * Fixing arm-id format in 4 examples * Adding missing location for 202 responses on sync examples --------- Co-authored-by: Ji Wang <[email protected]> Co-authored-by: Mohit Agarwal <[email protected]> Co-authored-by: GalGoldi72 <[email protected]> Co-authored-by: ilijadivljan-ms <[email protected]> Co-authored-by: Jovana Toroman <[email protected]> Co-authored-by: subhrob <[email protected]> Co-authored-by: subhrob <[email protected]> Co-authored-by: CelinaJiangJXY <[email protected]> Co-authored-by: beoberha <[email protected]> Co-authored-by: toki95 <[email protected]>
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:
Feature is already deployed. We are adding missing Response Code (HTTP 200) for our LRO POST actions - managedInstance/start & managedInstance/stop.
EO March 2023.
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.