Azure Firewall Policy Save and Commit #27391
Merged
openapi-pipeline-app / ~[NotRequired_Staging] Swagger LintDiff
completed
Jan 24, 2024 in 15m 23s
~[NotRequired_Staging] Swagger LintDiff failed
ppe/LintDiff: 32 Errors, 48 Warnings
The check status is neutral due to the check being suppressed by label Approved-LintDiff.
View Azure DevOps build log for more details.
Details
compared tags (via openapi-validator vbeta) | new version | base version |
---|---|---|
package-2023-11 | package-2023-11(26af8e9) | package-2023-11(release-network-Microsoft.Network-official-2023-11-01) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
NestedResourcesMustHaveListOperation |
The nested resource 'FirewallPolicyRuleCollectionGroupDraft' does not have list operation, please add it. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1536 |
|
TrackedResourcePatchOperation |
Tracked resource 'FirewallPolicyDraft' must have patch operation that at least supports the update of tags. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1448 |
RPC-Patch-V1-03 |
NestedResourcesMustHaveListOperation |
The nested resource 'FirewallPolicyDraft' does not have list operation, please add it. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1448 |
|
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1281 |
RPC-Get-V1-13 |
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1157 |
RPC-Put-V1-02 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1051 |
RPC-Get-V1-13 |
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L943 |
RPC-Put-V1-02 |
Schema should have a description or title. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1464 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1284 |
||
The response of operation:'FirewallPolicyRuleCollectionGroupDrafts_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1281 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1215 |
||
The response of operation:'FirewallPolicyRuleCollectionGroupDrafts_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1212 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1161 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1106 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1054 |
||
The response of operation:'FirewallPolicyDrafts_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1051 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1008 |
||
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L947 |
||
The response of operation:'FirewallPolicyDrafts_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L944 |
The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.
Rule | Message |
---|---|
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L2672 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L2644 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L2631 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L925 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L897 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L896 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L841 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L795 |
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/2023-11-01/firewallPolicy.json#L741 |
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/2023-11-01/firewallPolicy.json#L691 |
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/2023-11-01/firewallPolicy.json#L691 |
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/2023-11-01/firewallPolicy.json#L691 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L686 |
EvenSegmentedPathForPutOperation |
API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments). Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L686 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L631 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L572 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L395 |
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/firewallPolicy.json#L359 |
ResourceNameRestriction |
The resource name parameter 'ruleCollectionGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L358 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L358 |
PatchIdentityProperty |
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L236 |
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/firewallPolicy.json#L99 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L67 |
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/firewallPolicy.json#L38 |
ResourceNameRestriction |
The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L37 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L2668 |
|
The resource SignaturesOverrides does not have a corresponding delete operation. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L2651 |
|
Schema should have a description or title. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L2631 |
|
Schema should have a description or title. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L2539 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: get signature overrides Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L936 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L900 |
|
Based on the response model schema, operation 'FirewallPolicyIdpsSignaturesOverrides_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L897 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: query signature overrides Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L889 |
|
Parameter should have a description. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L846 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L845 |
|
OperationId should contain the verb: 'listidpsfilteroptions' in:'FirewallPolicyIdpsSignaturesFilterValues_List'. Consider updating the operationId Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L843 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L798 |
|
The response of operation:'FirewallPolicyIdpsSignaturesOverrides_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L795 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L744 |
|
'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/2023-11-01/firewallPolicy.json#L743 |
|
The response of operation:'FirewallPolicyIdpsSignaturesOverrides_Put' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L741 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L690 |
|
'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/2023-11-01/firewallPolicy.json#L688 |
|
The response of operation:'FirewallPolicyIdpsSignaturesOverrides_Patch' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L687 |
|
Parameter should have a description. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L653 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L635 |
|
OperationId should contain the verb: 'listidpssignatures' in:'FirewallPolicyIdpsSignatures_List'. Consider updating the operationId Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L633 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L579 |
|
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L491 |
|
The response of operation:'FirewallPolicyRuleCollectionGroups_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L485 |
Loading