-
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
Swagger for NRP's VipSwap operation #13639
Conversation
Hi, @shnaya434 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 |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
OperationId should contain the verb: 'setloadbalancerfrontendpublicipaddresses' in:'LoadBalancers_SwapPublicIpAddresses'. Consider updating the operationId Location: Microsoft.Network/stable/2021-02-01/loadBalancer.json#L1331 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces' Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces' Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}' Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
R3020 - PathResourceProviderNamePascalCase |
Resource provider naming must follow the pascal case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations' Location: azure-rest-api-specs/blob/f1b78c2b08c932288419fe524e456e01e8539fac/undefined#Lundefined |
️️✔️
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.
- Compared Swaggers (Based on Oad v0.8.8)
- original: stable/2020-11-01/loadBalancer.json <---> new: stable/2021-02-01/loadBalancer.json
️⚠️
[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"network/resource-manager/readme.md", "tag":"package-2021-02", "details":"Schema 'ResourceNavigationLink' has a property 'id' that is already declared the parent schema 'SubResource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ResourceNavigationLink" |
|
"readme":"network/resource-manager/readme.md", "tag":"package-2021-02", "details":"Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi, @shnaya434 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @lirenhe |
As the one in private repo was reviewed by ARM already, no need for ARM to review again. |
* Adds base for updating Microsoft.Network from version stable/2020-11-01 to version 2021-02-01 * Updates readme * Updates API version in new specs and examples * init (#13496) Co-authored-by: matyang222 <matthew.yang@microsoft.com> * Swagger change for CustomIpPrefix. Adding four new attributes. (#13456) * update swagger * fix apiversion * fix * add Co-authored-by: Weiheng Li <weihl@microsoft.com> * typo: paramter in applicationGateway.json (#13538) * VPN NAT for Virtual Network Gateway feature changes(networkFeb) (#13481) * commit1 * commit2 * resolving comments * pythonMd Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> * fix virtual network resource (#13570) * Added a new feature FlowTimeoutInMinutes under Virtual Network Proper… (#13519) * Added a new feature FlowTimeoutInMinutes under Virtual Network Properties * Updated the type from string to integer, added a non-null example * Added missing format for 'integer' type * Add new failedMessage property for CustomIpPrefix (#13607) * update swagger * fix apiversion * fix * add * add failedreason property * update swagger * fix apiversion * fix * add failedreason property * update Co-authored-by: Weiheng Li <weihl@microsoft.com> * Added Preferred Routing Gateway Support (#13611) * Feature: Address space update in peered vNets (#13521) * Adding new fields and operation to support the address space update in peered vNets Adding new fields and operation to support the address space update in peered vNets * Adding the new query param in the example As per the review comment, adding the new query param in the example request response of swagger. * Adding the new query param in examples Adding the new query param in examples * Restricting the sync param Restricting the sync param to hold only true as value. We never need to send false. Co-authored-by: Hari Prasad Perabattula <haperaba@microsoft.com> * Remove max file size limit enforcement as it is done in NRP (#13679) * Tesha/fix waf policy examples crs version (#13697) * Remove max file size limit enforcement as it is done in NRP * Update the CRS version in the examples to reflect latest * Fix (#13734) Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> * Swagger for NRP's VipSwap operation (#13639) * Swagger for NRP's VipSwap operation * Fixing validation errors * minor fix * Adding api version * Remove required (#13969) Co-authored-by: Will Ehrich <william.ehrich@microsoft.com> * Hotfix extended location parameter hierarchy (#13864) * add to feb branch * delete project name reference * expose two new client cert properties: validatedCertData, clientCertIssuerDN (#13989) * adding workloadType property for Baremetal scenarios (#14101) * Added bastion sku (#14248) * fix nrp resources based on s360 checks (#14219) * Adding Azure Network Manager association to the EffectiveNetworkSecurityGroups API (#14265) * Added Azure Network Manager association to the EffectiveNetworkSecurityGroupAssociation * Adding example for networkManager response in the EffectiveNSG call * Add deleteOption to PublicIPAddress (#14343) * Add deleteOption to PublicIPAddress * run validators Co-authored-by: Bashar Gharaibeh <basharghar@live.com> Co-authored-by: Matthew Yang <79727592+matyang22@users.noreply.github.com> Co-authored-by: matyang222 <matthew.yang@microsoft.com> Co-authored-by: Tom Li <weihengli.tj@gmail.com> Co-authored-by: Weiheng Li <weihl@microsoft.com> Co-authored-by: Nick Schonning <nschonni@gmail.com> Co-authored-by: Khushboo Baheti <37917868+Khushboo-Baheti@users.noreply.github.com> Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> Co-authored-by: guptas14 <71726901+guptas14@users.noreply.github.com> Co-authored-by: Satya-anshu <70507845+Satya-anshu@users.noreply.github.com> Co-authored-by: arvenka <arvenka@microsoft.com> Co-authored-by: Hari Prasad Perabattula <harics24@users.noreply.github.com> Co-authored-by: Hari Prasad Perabattula <haperaba@microsoft.com> Co-authored-by: tejasshah7 <49326906+tejasshah7@users.noreply.github.com> Co-authored-by: shnaya434 <67019054+shnaya434@users.noreply.github.com> Co-authored-by: William Ehrich <wdehrich@gmail.com> Co-authored-by: Will Ehrich <william.ehrich@microsoft.com> Co-authored-by: litchiyangMSFT <64560090+litchiyangMSFT@users.noreply.github.com> Co-authored-by: biaogao <biga@microsoft.com> Co-authored-by: bhbhise <83041483+bhbhise@users.noreply.github.com> Co-authored-by: mscorp-buchen <78105006+mscorp-buchen@users.noreply.github.com> Co-authored-by: Arpit Agarwal <83313290+aragar740@users.noreply.github.com> Co-authored-by: basharg <basharg@microsoft.com> Co-authored-by: Bashar Gharaibeh <basharghar@live.com>
* Adds base for updating Microsoft.Network from version stable/2020-11-01 to version 2021-02-01 * Updates readme * Updates API version in new specs and examples * init (Azure#13496) Co-authored-by: matyang222 <matthew.yang@microsoft.com> * Swagger change for CustomIpPrefix. Adding four new attributes. (Azure#13456) * update swagger * fix apiversion * fix * add Co-authored-by: Weiheng Li <weihl@microsoft.com> * typo: paramter in applicationGateway.json (Azure#13538) * VPN NAT for Virtual Network Gateway feature changes(networkFeb) (Azure#13481) * commit1 * commit2 * resolving comments * pythonMd Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> * fix virtual network resource (Azure#13570) * Added a new feature FlowTimeoutInMinutes under Virtual Network Proper… (Azure#13519) * Added a new feature FlowTimeoutInMinutes under Virtual Network Properties * Updated the type from string to integer, added a non-null example * Added missing format for 'integer' type * Add new failedMessage property for CustomIpPrefix (Azure#13607) * update swagger * fix apiversion * fix * add * add failedreason property * update swagger * fix apiversion * fix * add failedreason property * update Co-authored-by: Weiheng Li <weihl@microsoft.com> * Added Preferred Routing Gateway Support (Azure#13611) * Feature: Address space update in peered vNets (Azure#13521) * Adding new fields and operation to support the address space update in peered vNets Adding new fields and operation to support the address space update in peered vNets * Adding the new query param in the example As per the review comment, adding the new query param in the example request response of swagger. * Adding the new query param in examples Adding the new query param in examples * Restricting the sync param Restricting the sync param to hold only true as value. We never need to send false. Co-authored-by: Hari Prasad Perabattula <haperaba@microsoft.com> * Remove max file size limit enforcement as it is done in NRP (Azure#13679) * Tesha/fix waf policy examples crs version (Azure#13697) * Remove max file size limit enforcement as it is done in NRP * Update the CRS version in the examples to reflect latest * Fix (Azure#13734) Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> * Swagger for NRP's VipSwap operation (Azure#13639) * Swagger for NRP's VipSwap operation * Fixing validation errors * minor fix * Adding api version * Remove required (Azure#13969) Co-authored-by: Will Ehrich <william.ehrich@microsoft.com> * Hotfix extended location parameter hierarchy (Azure#13864) * add to feb branch * delete project name reference * expose two new client cert properties: validatedCertData, clientCertIssuerDN (Azure#13989) * adding workloadType property for Baremetal scenarios (Azure#14101) * Added bastion sku (Azure#14248) * fix nrp resources based on s360 checks (Azure#14219) * Adding Azure Network Manager association to the EffectiveNetworkSecurityGroups API (Azure#14265) * Added Azure Network Manager association to the EffectiveNetworkSecurityGroupAssociation * Adding example for networkManager response in the EffectiveNSG call * Add deleteOption to PublicIPAddress (Azure#14343) * Add deleteOption to PublicIPAddress * run validators Co-authored-by: Bashar Gharaibeh <basharghar@live.com> Co-authored-by: Matthew Yang <79727592+matyang22@users.noreply.github.com> Co-authored-by: matyang222 <matthew.yang@microsoft.com> Co-authored-by: Tom Li <weihengli.tj@gmail.com> Co-authored-by: Weiheng Li <weihl@microsoft.com> Co-authored-by: Nick Schonning <nschonni@gmail.com> Co-authored-by: Khushboo Baheti <37917868+Khushboo-Baheti@users.noreply.github.com> Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> Co-authored-by: guptas14 <71726901+guptas14@users.noreply.github.com> Co-authored-by: Satya-anshu <70507845+Satya-anshu@users.noreply.github.com> Co-authored-by: arvenka <arvenka@microsoft.com> Co-authored-by: Hari Prasad Perabattula <harics24@users.noreply.github.com> Co-authored-by: Hari Prasad Perabattula <haperaba@microsoft.com> Co-authored-by: tejasshah7 <49326906+tejasshah7@users.noreply.github.com> Co-authored-by: shnaya434 <67019054+shnaya434@users.noreply.github.com> Co-authored-by: William Ehrich <wdehrich@gmail.com> Co-authored-by: Will Ehrich <william.ehrich@microsoft.com> Co-authored-by: litchiyangMSFT <64560090+litchiyangMSFT@users.noreply.github.com> Co-authored-by: biaogao <biga@microsoft.com> Co-authored-by: bhbhise <83041483+bhbhise@users.noreply.github.com> Co-authored-by: mscorp-buchen <78105006+mscorp-buchen@users.noreply.github.com> Co-authored-by: Arpit Agarwal <83313290+aragar740@users.noreply.github.com> Co-authored-by: basharg <basharg@microsoft.com> Co-authored-by: Bashar Gharaibeh <basharghar@live.com>
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 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.