Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 #29048
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
…gger to match the bugfix in 2023-11-01
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| networkVirtualAppliance.json | 2024-01-01(6d48ebc) | 2023-11-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version adds a response code '202'. New: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L333:11 |
|
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L289:7 Old: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L289:7 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-01 | package-2024-01(6d48ebc) | package-2024-01(release-network-Microsoft.Network-2024-01-01) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L37 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L38 |
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L105 |
|
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L181 |
|
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L288 |
|
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L448 |
|
The resource name parameter 'siteName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L448 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L449 |
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L488 |
|
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L641 |
|
The path must be under a subscription and resource group for tracked resource types. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L733 |
|
The resource name parameter 'skuName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L733 |
|
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L776 |
|
The resource name parameter 'ruleCollectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L776 |
|
The schema 'NetworkVirtualAppliance' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L851 |
|
The schema 'NetworkVirtualAppliancePropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L875 |
|
The schema 'VirtualApplianceSkuProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1011 |
|
The schema 'VirtualApplianceNicProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1031 |
|
The schema 'VirtualApplianceSite' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1169 |
|
The schema 'VirtualApplianceSiteProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1198 |
|
The schema 'Office365PolicyProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1218 |
|
The schema 'BreakOutCategoryPolicies' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1228 |
|
The resource NetworkVirtualApplianceSku does not have a corresponding delete operation. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1248 |
|
The schema 'NetworkVirtualApplianceSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1248 |
|
Tracked resource 'NetworkVirtualApplianceSku' must have patch operation that at least supports the update of tags. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1248 |
|
The tracked resource NetworkVirtualApplianceSku does not have a corresponding put operation. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1248 |
|
The schema 'NetworkVirtualApplianceSkuPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1269 |
|
The schema 'NetworkVirtualApplianceSkuInstances' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1295 |
|
The schema 'NetworkVirtualApplianceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1312 |
|
The schema 'NetworkVirtualApplianceSiteListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1328 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
7 tasks
This was referenced May 9, 2024
AzureRestAPISpecReview
added
ARMReview
resource-manager
WaitForARMFeedback
This was referenced May 9, 2024
mentat9
added
ARMSignedOff
…tib/restart-fix-response
|
/pr RequestMerge |
mentat9
approved these changes
May 16, 2024
|
@arsheen - You should be able to merge this PR yourself. ARM team only merges to main and RPSaaSMaster in the private repo. Normally you would also get a required approving review from someone on your team but I did that approval for you. |
mentat9
merged commit 117cbc9
into
Azure:release-network-Microsoft.Network-2024-01-01
23 of 29 checks passed
rkmanda
pushed a commit
that referenced
this pull request
Jun 19, 2024
…29302) * Adds base for updating Microsoft.Network from version stable/2023-11-01 to version 2024-01-01 * Updates readme * Updates API version in new specs and examples * Add examples for Subnet peering and v6 Subnet peering. (#28827) Add examples for Subnet peering and v6 Subnet peering. --------- Co-authored-by: saurabh83 <saugu@microsoft.com> * Init (#29127) Co-authored-by: Abhishek Shah <shabhis@microsoft.com> * Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 (#29048) Co-authored-by: Arsheen Khatib (from Dev Box) <akhatib@microsoft.com> * Added NoHealthyBackendsBehavior (#28868) Added the property "NoHealthyBackendsBehavior" to the Probe properties. * VirtualNetworkGatewayConnection using key vault for authentication. (#28760) * Add parameters for cert based auth connection * retrigger checks * retrigger checks * lintDiff * Trigger Build * revert PATCH changes * fix * change managed identity to v5 * add format and description * rresolving conflict * resolving readme file * Revert "VirtualNetworkGatewayConnection using key vault for authentication. (#28760)" This reverts commit c37ec24. * Lint diff error suppress * Guptavertika/release network microsoft.network official 2024 01 01 (#29367) * added networkidentifier under vnet->subet->serviceendpoint * added format :armid and updated description * corrected the type * fixed response * response type fixed example --------- Co-authored-by: Bhupesh Bhatt <bhupeshbhatt@microsoft.com> * Adding GET operaton for Network Virtual Appliance Inbound Secuirty Rule (#29339) (#29375) * Fix for PR VirtualNetworkGatewayConnection using key vault for authentication. (#29357) (#29376) * Fix * Fix2 --------- Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> * Add CrossConnection Name as an optional query parameter in List ExpressRoute CrossConnection (#29251) * Add CrossConnection name as an optional query parameter for List CrossConnection * update example * Addressing comments * Change to OData filtering * Fix the parameter reference * Update --------- Co-authored-by: Jianqi Zhao <jianzhao@microsoft.com> * initial changes (#29235) * Changed type of networkIdentifier from PublicIPAddress to SubResource (#29469) * added networkidentifier under vnet->subet->serviceendpoint * added format :armid and updated description * corrected the type * fixed response * response type fixed example * Changed type of networkIdentifier from ./publicIpAddress.json#/definitions/PublicIPAddress to ./network.json#/definitions/SubResource --------- Co-authored-by: Bhupesh Bhatt <bhupeshbhatt@microsoft.com> --------- Co-authored-by: saurabh83 <splitt@gmail.com> Co-authored-by: saurabh83 <saugu@microsoft.com> Co-authored-by: Abhishek Shah <16267081+abhi7860@users.noreply.github.com> Co-authored-by: Abhishek Shah <shabhis@microsoft.com> Co-authored-by: AFK1194 <arsheen.khatib@gmail.com> Co-authored-by: Arsheen Khatib (from Dev Box) <akhatib@microsoft.com> Co-authored-by: Eugenio Peña García <70240915+EugenioPena@users.noreply.github.com> Co-authored-by: daweiwang-microsoft <165709729+daweiwang-microsoft@users.noreply.github.com> Co-authored-by: Bhupesh Kumar Bhatt <52891188+bhupeshbhatt1985@users.noreply.github.com> Co-authored-by: Bhupesh Bhatt <bhupeshbhatt@microsoft.com> Co-authored-by: Ashutosh Mishra <163998769+ashutmi@users.noreply.github.com> Co-authored-by: Khushboo Baheti <37917868+Khushboo-Baheti@users.noreply.github.com> Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> Co-authored-by: jianzhao1992 <125631957+jianzhao1992@users.noreply.github.com> Co-authored-by: Jianqi Zhao <jianzhao@microsoft.com> Co-authored-by: nimaller <71352534+nimaller@users.noreply.github.com>
mentat9
pushed a commit
that referenced
this pull request
Jun 21, 2024
#29473) * Adds base for updating Microsoft.Network from version stable/2023-11-01 to version 2024-01-01 * Updates readme * Updates API version in new specs and examples * Add examples for Subnet peering and v6 Subnet peering. (#28827) Add examples for Subnet peering and v6 Subnet peering. --------- Co-authored-by: saurabh83 <saugu@microsoft.com> * Init (#29127) Co-authored-by: Abhishek Shah <shabhis@microsoft.com> * Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 (#29048) Co-authored-by: Arsheen Khatib (from Dev Box) <akhatib@microsoft.com> * Added NoHealthyBackendsBehavior (#28868) Added the property "NoHealthyBackendsBehavior" to the Probe properties. * VirtualNetworkGatewayConnection using key vault for authentication. (#28760) * Add parameters for cert based auth connection * retrigger checks * retrigger checks * lintDiff * Trigger Build * revert PATCH changes * fix * change managed identity to v5 * add format and description * added networkidentifier under vnet->subet->serviceendpoint (#29292) * added networkidentifier under vnet->subet->serviceendpoint * resolving conflict (#29343) * Fix for PR VirtualNetworkGatewayConnection using key vault for authentication. (#29357) * Fix * Fix2 --------- Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> * Adding GET operaton for Network Virtual Appliance Inbound Secuirty Rule (#29339) * Moving missed changes from 2023-11-01 packet capture swagger fix to latest api version * Add CrossConnection Name as an optional query parameter in List ExpressRoute CrossConnection (#29251) * Add CrossConnection name as an optional query parameter for List CrossConnection * update example * Addressing comments * Change to OData filtering * Fix the parameter reference * Update --------- Co-authored-by: Jianqi Zhao <jianzhao@microsoft.com> * initial changes (#29235) * adding supression for the breaking change in azure-sdk-for-go * adding correct package for this supression --------- Co-authored-by: GuptaVertika <149072034+GuptaVertika@users.noreply.github.com> Co-authored-by: saurabh83 <splitt@gmail.com> Co-authored-by: saurabh83 <saugu@microsoft.com> Co-authored-by: Abhishek Shah <16267081+abhi7860@users.noreply.github.com> Co-authored-by: Abhishek Shah <shabhis@microsoft.com> Co-authored-by: AFK1194 <arsheen.khatib@gmail.com> Co-authored-by: Arsheen Khatib (from Dev Box) <akhatib@microsoft.com> Co-authored-by: Eugenio Peña García <70240915+EugenioPena@users.noreply.github.com> Co-authored-by: daweiwang-microsoft <165709729+daweiwang-microsoft@users.noreply.github.com> Co-authored-by: Bhupesh Kumar Bhatt <52891188+bhupeshbhatt1985@users.noreply.github.com> Co-authored-by: Khushboo Baheti <37917868+Khushboo-Baheti@users.noreply.github.com> Co-authored-by: Khushboo Baheti <khbaheti@microsoft.com> Co-authored-by: Ashutosh Mishra <163998769+ashutmi@users.noreply.github.com> Co-authored-by: jianzhao1992 <125631957+jianzhao1992@users.noreply.github.com> Co-authored-by: Jianqi Zhao <jianzhao@microsoft.com> Co-authored-by: nimaller <71352534+nimaller@users.noreply.github.com>
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.
Please review the same bugfix changes being added to the 2023-11-01 release as well
#28959
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.