Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Azure Firewall Policy Save and Commit #27391

Merged
merged 11 commits into from
Jan 30, 2024

remove 2023-09 api

26af8e9
Select commit
Loading
Failed to load commit list.
Merged

Azure Firewall Policy Save and Commit #27391

remove 2023-09 api
26af8e9
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff completed Jan 24, 2024 in 16m 11s

Swagger LintDiff failed

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 v2.1.6) 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]
❌ 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
❌ 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#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#L1281		 RPC-Get-V1-13
❌ NestedResourcesMustHaveListOperation The nested resource 'FirewallPolicyDraft' does not have list operation, please add it.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1448
❌ 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 'FirewallPolicyRuleCollectionGroupDraft' does not have list operation, please add it.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1536
⚠️ RequiredReadOnlySystemData 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
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L947
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1008
⚠️ RequiredReadOnlySystemData 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
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1054
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1106
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1161
⚠️ RequiredReadOnlySystemData 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
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1215
⚠️ RequiredReadOnlySystemData 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
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1284
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L1464


The following errors/warnings exist before current PR submission:
Only 50 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/2023-11-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/2023-11-01/firewallPolicy.json#L38
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2023-11-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/2023-11-01/firewallPolicy.json#L99
❌ PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L236
❌ ResourceNameRestriction The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L358
❌ ResourceNameRestriction The resource name parameter 'ruleCollectionGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2023-11-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/2023-11-01/firewallPolicy.json#L359
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L395
❌ ResourceNameRestriction The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L572
❌ ResourceNameRestriction The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L631
❌ 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#L686
❌ 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
❌ 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 '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
❌ 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
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L795
❌ ResourceNameRestriction The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L841
❌ ResourceNameRestriction The resource name parameter 'firewallPolicyName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L896
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.Network/stable/2023-11-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/2023-11-01/firewallPolicy.json#L925
❌ 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
❌ 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#L2672
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L44
⚠️ RequiredReadOnlySystemData The response of operation:'FirewallPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L93
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L99
⚠️ RequiredReadOnlySystemData The response of operation:'FirewallPolicies_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L148
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L154
⚠️ RequiredReadOnlySystemData The response of operation:'FirewallPolicies_UpdateTags' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L215
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L221
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L280
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L365
⚠️ RequiredReadOnlySystemData The response of operation:'FirewallPolicyRuleCollectionGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L421
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L427
⚠️ RequiredReadOnlySystemData 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
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L491
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L579
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listidpssignatures' in:'FirewallPolicyIdpsSignatures_List'. Consider updating the operationId
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L633
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L635
⚠️ ParameterDescription Parameter should have a description.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L653
⚠️ RequiredReadOnlySystemData 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
⚠️ PatchInOperationName '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
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L690
⚠️ RequiredReadOnlySystemData 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
⚠️ PutInOperationName '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
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L744
⚠️ RequiredReadOnlySystemData 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
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2023-11-01/firewallPolicy.json#L798
View more details on openapi-pipeline-app