Minor Fixes for TrafficController 2022-10-01-preview#22888
Conversation
|
Hi, @malpaniHMC 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 Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @malpaniHMC, 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. |
|
Hi @malpaniHMC, Your PR has some issues. Please fix the CI sequentially by following the order of
|
| "type": "string", | ||
| "enum": [ | ||
| "subnets" | ||
| "Subnet" |
There was a problem hiding this comment.
I thought we agreed to use the plural "Subnets" for AssociationType? NFVRP is already serializing this enum as plural.
|
Breaking change due to enum value changes. RP is first release and in private preview. Breaking change signed off. |
allenjzhang
added
the
Approved-BreakingChange
allenjzhang
left a comment
allenjzhang
left a comment
There was a problem hiding this comment.
Please check in the corresponding updated cadl file.
| "type": "string", | ||
| "enum": [ | ||
| "public" | ||
| "Public" |
There was a problem hiding this comment.
Is this change going into a new API version? Right now NFVRP serializes this enum with "camelCase" for all versions. The code is setup so that for future API versions we could serialize with "PascalCase". But if we change the casing in-place, some SDKs might be broken again.
Swagger Generation Artifacts
|
* regex changes * enum errors * reverting enum changes, uupdating cadl, updating regex * reverting example enum changes
5 participants
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.