RMS - Adding changes to fix the correctness validation issues. #12189
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
…erties - prov state, nat rules. Case correction - fqdn.
|
Hi, @punit1396 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. vsswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| 'networkSecurityGroup' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.Migrate/preview/2019-10-01-preview/resourcemovercollection.json#L1817 |
|
| 'publicIp' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.Migrate/preview/2019-10-01-preview/resourcemovercollection.json#L1999 |
️️✔️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 @punit1396, 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. |
|
Resource mover service is still in public preview and the changes in question are in reply to the Live Validation Correctness failures. These properties have been a part of the service since before our public preview started (August'20). @innosam for reference |
This was referenced Dec 21, 2020
punit-bhatt
changed the title
…in NIC IP settings.
innosam
approved these changes
Jan 7, 2021
punit-bhatt
changed the title
|
@leni-msft |
|
@punit1396 since there's a breaking change error, pls follow the process to request approval. Also, follow the guide https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/405/Window-to-Fix-Broken , so that it would be more likely to be approved. |
|
@leni-msft Hello! If you are receiving this message, it's because you are listed as a PM Owner contact or Dev Owner contact for a service with an ARM RP Namespace onboarded in Service Tree. This message is intended for the overall ARM RP Namespace Contact and this metadata value is blank for your service or services in Service Tree. To help us target future ARM RP-related communication, please follow these instructions to update the ARM Namespace Contact field with the correct alias(es). You can view all Service Tree contact information in one place in this report to ensure the contact information for your service(s) and RP is accurate. There are some updates about Swagger Tooling and PR Review process worth your attention. Window to Fix Broken In order to drive higher Swagger Correctness, with agreement of Azure Breaking Change Board, and Azure SDKs/CLIs teams, we decide to open a window for service teams to “fix broken” with current version. Which means you are able to fix some Swagger Correctness issues, like OBJECT_ADDITIONAL_PROPERTIES, INVALID_RESPONSE_CODE, ROUNDTRIP_ADDITIONAL_PROPERTY, etc., in the version with issues, no more require of creating a new version to accommodate breaking changes with fixes. However, the window is only available by the end of January 2021. After January, all breaking changes must be justified. There is further guidance available in this wiki Window to Fix Broken - Overview (azure.com). If any further question, please reach out to me or Swagger KPIs Communication swaggerkpiscomm@microsoft.com. |
|
@punit1396 The process didn't change, you will still need request approval from breaking change team. |
|
@leni-msft, I have removed the breaking changes. Could you take a look? |
This was referenced Jan 18, 2021
Closed
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…#12189) * Adding changes to fix the correctness validation issues. Missing properties - prov state, nat rules. Case correction - fqdn. * Removing prov state. * Adding other missing properties. NSG in SubnetSettings and Public IP in NIC IP settings. * Removing property case change
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.
Missing properties -
1 - LB Nat rules in NIC IP ResourceSettings.
2 - NSG reference in Subnet Resource Settings.
3 - Public IP reference in NIC IP Resource Settings.
Case correction - fqdn instead of fQDN in PublicIPResourceSettings.
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.