-
Notifications
You must be signed in to change notification settings - Fork 5.5k
fixed url for signature overrides - replaced with correct intrusionDe… #28966
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
Conversation
…tectionSignaturesOverrides
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 |
---|---|---|
firewallPolicy.json | 2024-01-01(2f13c83) | 2023-11-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default' removed or restructured? Old: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L686:5 |
️❌
LintDiff: 7 Errors, 8 Warnings failed [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-2024-01 | package-2024-01(2f13c83) | package-2024-01(release-network-Microsoft.Network-2024-01-01) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L686 |
RPC-Put-V1-02 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L686 |
RPC-Uri-V1-05 |
UnSupportedPatchProperties |
Mark the top-level property 'id', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L691 |
RPC-Patch-V1-02 |
UnSupportedPatchProperties |
Mark the top-level property 'name', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L691 |
RPC-Patch-V1-02 |
UnSupportedPatchProperties |
Mark the top-level property 'type', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L691 |
RPC-Patch-V1-02 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L741 |
RPC-Async-V1-11, RPC-Put-V1-11 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L795 |
RPC-Get-V1-13 |
The response of operation:'FirewallPolicyIdpsSignaturesOverrides_Patch' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L687 |
||
'PATCH' operation 'FirewallPolicyIdpsSignaturesOverrides_Patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L688 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L701 |
||
The response of operation:'FirewallPolicyIdpsSignaturesOverrides_Put' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L741 |
||
'PUT' operation 'FirewallPolicyIdpsSignaturesOverrides_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L743 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L755 |
||
The response of operation:'FirewallPolicyIdpsSignaturesOverrides_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L795 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L800 |
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 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.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/2024-01-01/firewallPolicy.json#L38 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L67 |
ParametersInPointGet |
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/firewallPolicy.json#L99 |
PatchIdentityProperty |
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L236 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L358 |
ResourceNameRestriction |
The resource name parameter 'ruleCollectionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L358 |
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/2024-01-01/firewallPolicy.json#L359 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L395 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L572 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L631 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L841 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L896 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L897 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L925 |
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L943 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L1051 |
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L1157 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L1281 |
NestedResourcesMustHaveListOperation |
The nested resource 'FirewallPolicyDraft' does not have list operation, please add it. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L1448 |
TrackedResourcePatchOperation |
Tracked resource 'FirewallPolicyDraft' must have patch operation that at least supports the update of tags. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L1448 |
NestedResourcesMustHaveListOperation |
The nested resource 'FirewallPolicyRuleCollectionGroupDraft' does not have list operation, please add it. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L1536 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L2631 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L2644 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L2672 |
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L46 |
|
The response of operation:'FirewallPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L93 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L101 |
|
The response of operation:'FirewallPolicies_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L148 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2024-01-01/firewallPolicy.json#L156 |
️❌
Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/firewallPolicies/{}/signatureOverrides/default is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2023-11-01/firewallPolicy.json |
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
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
|
Thank you for your contribution mtatarik! We will review the pull request and get back to you soon. |
@@ -683,7 +683,7 @@ | |||
} | |||
} | |||
}, | |||
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default": { | |||
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/intrusionDetectionSignaturesOverrides/default": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also needs to change to intrusionDetectionSignaturesOverrides Refers to: specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/firewallPolicy.json:896 in 2f13c83. [](commit_id = 2f13c83, deletion_comment = False) |
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.