-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added first stable version for managed resolver #19553
Added first stable version for managed resolver #19553
Conversation
Hi, @arpit-gagneja 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.6)] | new version | base version |
---|---|---|
dnsresolver.json | 2022-07-01(3707282) | 2020-04-01(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-07 | package-2022-07(3707282) | default(main) |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 5 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"Using directive.0.suppress which is deprecated and will be removed in the future." |
|
"readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"Using directive.1.suppress which is deprecated and will be removed in the future." |
|
"readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"Using directive.2.suppress which is deprecated and will be removed in the future." |
|
"readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"Using directive.3.suppress which is deprecated and will be removed in the future." |
|
"readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"Using directive.4.suppress which is deprecated and will be removed in the future." |
|
💬 | "readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"AutoRest core version selected from configuration: ^3.2.0." |
💬 | "readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)" |
💬 | "readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)" |
💬 | "readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)" |
💬 | "readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)" |
💬 | "readme":"dnsresolver/resource-manager/readme.md", "tag":"package-2022-07", "details":"Autorest completed in 12.55s. 0 files generated." |
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
@honghr: I want to give you some context, My team service recently went for public preview last month. Now, we are checking the first stable version for planned GA in September this year. The stable version has some minor diff with respect to public preview swagger. Motivation behind new changes in swagger for GA: Couple of questions:
|
...source-manager/Microsoft.Network/stable/2022-06-21/examples/DnsForwardingRuleset_Delete.json
Outdated
Show resolved
Hide resolved
Hi, @arpit-gagneja your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
specification/dnsresolver/resource-manager/Microsoft.Network/stable/2022-06-21/dnsresolver.json
Outdated
Show resolved
Hide resolved
Making a property required is considered a breaking change across versions because you are now forcing the client to behave differently. However, if this change is modifying a previous behavior that was "only" exposed in a preview version then it should be ok to make this change. On the other hand if this change is modifying a previous behavior that was exposed in a GA/stable version, it would be considered a strict breaking change and will not be allowed unless there is a strong reason stated and you receive an exception from the breaking changes reviewers. Please generate the PR as per the guidelines of generating a PR for a new API version - note the links I shared in another comment. That will help us clearly view the difference between this version and the previous preview version. In reply to: 1162438083 |
Also if you can provide a link to the PR for the preview version that was signed off earlier by ARM, it will make this review go faster In reply to: 1162545736 |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
Hi @arpit-gagneja, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This reverts commit 7ce9c57.
|
@rkmanda : Can I suppress the breaking change (cross-version) CI check in this case? because this change is modifying a previous behavior that was "only" exposed in a preview version. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Hi @arpit-gagneja, 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. |
@honghr : This version will be the first stable version for GA. So there isn't any breaking change. I am pasting the chat with the ARM team member about it. I have received the ARM sign off after that chat. |
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for 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
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change 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.