-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Fixing the Network Virtual Appliance Restart Http return code to match the REST API #28959
Merged
mentat9
merged 9 commits into
Azure:main
from
arsheen:akhatib/hotfix-restart-network-virtual-appliance
May 16, 2024
Merged
Fixing the Network Virtual Appliance Restart Http return code to match the REST API #28959
mentat9
merged 9 commits into
Azure:main
from
arsheen:akhatib/hotfix-restart-network-virtual-appliance
May 16, 2024
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
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
Compared specs (v0.10.8) | new version | base version |
---|---|---|
networkVirtualAppliance.json | 2023-11-01(35938ab) | 2023-11-01(main) |
Rule | Message |
---|---|
1011 - AddingResponseCode |
The new version adds a response code '202'. New: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L333:11 |
1044 - XmsLongRunningOperationChanged |
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L289:7 Old: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L289:7 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-2023-11-preview | package-2023-11-preview(35938ab) | package-2023-11-preview(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L37 |
DeleteResponseCodes |
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/2023-11-01/networkVirtualAppliance.json#L38 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L105 |
PatchIdentityProperty |
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L181 |
ResourceNameRestriction |
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L288 |
ResourceNameRestriction |
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L448 |
ResourceNameRestriction |
The resource name parameter 'siteName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L448 |
DeleteResponseCodes |
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/2023-11-01/networkVirtualAppliance.json#L449 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L488 |
ResourceNameRestriction |
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L641 |
PathForTrackedResourceTypes |
The path must be under a subscription and resource group for tracked resource types. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L733 |
ResourceNameRestriction |
The resource name parameter 'skuName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L733 |
ResourceNameRestriction |
The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L776 |
ResourceNameRestriction |
The resource name parameter 'ruleCollectionName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L776 |
MissingTypeObject |
The schema 'NetworkVirtualAppliance' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L851 |
MissingTypeObject |
The schema 'NetworkVirtualAppliancePropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L875 |
MissingTypeObject |
The schema 'VirtualApplianceSkuProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1011 |
MissingTypeObject |
The schema 'VirtualApplianceNicProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1031 |
MissingTypeObject |
The schema 'VirtualApplianceSite' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1169 |
MissingTypeObject |
The schema 'VirtualApplianceSiteProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1198 |
MissingTypeObject |
The schema 'Office365PolicyProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1218 |
MissingTypeObject |
The schema 'BreakOutCategoryPolicies' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1228 |
AllTrackedResourcesMustHaveDelete |
The resource NetworkVirtualApplianceSku does not have a corresponding delete operation. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1248 |
MissingTypeObject |
The schema 'NetworkVirtualApplianceSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1248 |
TrackedResourcePatchOperation |
Tracked resource 'NetworkVirtualApplianceSku' must have patch operation that at least supports the update of tags. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1248 |
TrackedResourcesMustHavePut |
The tracked resource NetworkVirtualApplianceSku does not have a corresponding put operation. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1248 |
MissingTypeObject |
The schema 'NetworkVirtualApplianceSkuPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1269 |
MissingTypeObject |
The schema 'NetworkVirtualApplianceSkuInstances' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1295 |
MissingTypeObject |
The schema 'NetworkVirtualApplianceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json#L1312 |
MissingTypeObject |
The schema 'NetworkVirtualApplianceSiteListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-11-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.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced May 3, 2024
arsheen
added
BreakingChangeReviewRequired
<valid label in PR review process>add this label when breaking change review is required
ARMReview
labels
May 3, 2024
This was referenced May 3, 2024
arsheen
changed the title
Fixing the Netwotk Virtual Appliance Restart Http return code to match the REST API
Fixing the Network Virtual Appliance Restart Http return code to match the REST API
May 6, 2024
AzureRestAPISpecReview
added
the
ReadyForApiTest
<valid label in PR review process>add this label when swagger and service APIs are ready for test
label
May 6, 2024
mikekistler
added
the
BreakingChange-Approved-BugFix
Changes are to correct the REST API definition to correctly describe service behavior
label
May 6, 2024
/azp run |
Azure Pipelines successfully started running 4 pipeline(s). |
arsheen
force-pushed
the
akhatib/hotfix-restart-network-virtual-appliance
branch
from
May 6, 2024 18:52
1a7448a
to
27b5fa8
Compare
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
AzureRestAPISpecReview
added
WaitForARMFeedback
<valid label in PR review process> add this label when ARM review is required
and removed
NotReadyForARMReview
labels
May 6, 2024
arsheen
added
do-not-merge
MergeRequested
and removed
do-not-merge
MergeRequested
labels
May 7, 2024
7 tasks
mentat9
added
ARMSignedOff
<valid label in PR review process>add this label when ARM approve updates after review
and removed
WaitForARMFeedback
<valid label in PR review process> add this label when ARM review is required
labels
May 15, 2024
/azp run |
Commenter does not have sufficient privileges for PR 28959 in repo Azure/azure-rest-api-specs |
/azp run |
Commenter does not have sufficient privileges for PR 28959 in repo Azure/azure-rest-api-specs |
/pr RequestMerge |
mentat9
approved these changes
May 16, 2024
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
…h the REST API (Azure#28959) * Fixing the Netwotk Virtual Appliance Restart Http return code to match the REST API * Adding a header to the description * Fixing error * Fixing check failures * Adding examples * Add schema to the 200 response * Adding schema to examples and 202 * Remove schema for 202 --------- Co-authored-by: Arsheen Khatib <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
ARMReview
ARMSignedOff
<valid label in PR review process>add this label when ARM approve updates after review
BreakingChange-Approved-BugFix
Changes are to correct the REST API definition to correctly describe service behavior
BreakingChangeReviewRequired
<valid label in PR review process>add this label when breaking change review is required
ReadyForApiTest
<valid label in PR review process>add this label when swagger and service APIs are ready for test
resource-manager
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 changes being added to the current release(2024-01-01) as well:
#29048
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section 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 ApiView
comment 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 PR
andDue diligence checklist
.Next Steps to Merge
comment. 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.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.