Feature/riteshc/swagger correctness mhsm fixes #12209
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
Merge Azure/azure-rest-api-specs into riteshchitlangia1/azure-rest-api-specs
Merge Azure/azure-rest-api-specs/master to riteshchitlangia1/azure-rest-api-specs/master
riteshchitlangia1
requested review from
heaths,
jlichwa and
RandalliLama
as code owners
|
Hi, @riteshchitlangia1 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
|
| Rule | Message |
|---|---|
|
The new version adds a response code '202'. New: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L237:11 |
|
The new version adds a response code '204'. New: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L240:11 |
|
The new version has a different default value than the previous one. New: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L417:9 Old: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L410:9 |
|
The read only property has changed from 'false' to 'true'. New: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L401:9 Old: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L395:9 |
️⚠️LintDiff: 1 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- Linted configuring files (Based on target branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
| Rule | Message |
|---|---|
| The operation 'ManagedHsms_Get' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L206 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
|
Hi @riteshchitlangia1, 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 Dec 22, 2020
|
Breaking changes : this version is still preview so breaking changes are fine. |
fengzhou-msft
approved these changes
Dec 23, 2020
|
@akning-ms @josefree can you help confirm that this is a |
|
Hi @riteshchitlangia1, can you provide a link for your ADO work item for S360 and list the item you try to fix. |
Here's the link to S360 work item: https://msazure.visualstudio.com/Swagger%20KPIs/_workitems/edit/8187858 https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=CE6F3670-D5E6-48BE-90EB-CE2FF755D4E4 |
I have also submitted request to breaking change review board for approval. |
JeffreyRichter
approved these changes
Jan 5, 2021
heaths
approved these changes
Jan 5, 2021
fengzhou-msft
added
the
Approved-BreakingChange
This was referenced Jan 6, 2021
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.
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 API 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.