-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Add support for JSChallenge action in Application Gateway Web application Firewall #26149
Add support for JSChallenge action in Application Gateway Web application Firewall #26149
Conversation
Add support for JSChallenge action in the list of supported actions for Custom rules and Managed rules
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
webapplicationfirewall.json | 2023-06-01(78e5864) | 2023-05-01(main) |
️❌
LintDiff: 6 Errors, 0 Warnings failed [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-2023-06 | package-2023-06(78e5864) | package-2023-06(release-network-Microsoft.Network-official-2023-06-01) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
FATAL
|
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManager.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 2: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 3: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 4: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 5: Location: azure-rest-api-specs/blob/78e5864e41bbf739f589b3e227f905b87e67181e/#L1 |
|
FATAL
|
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerConnection.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/78e5864e41bbf739f589b3e227f905b87e67181e/#L1 |
|
FATAL
|
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerConnectivityConfiguration.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 2: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 3: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/78e5864e41bbf739f589b3e227f905b87e67181e/#L1 |
|
FATAL
|
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerGroup.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 2: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 3: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 4: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 5: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/78e5864e41bbf739f589b3e227f905b87e67181e/#L1 |
|
FATAL
|
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerScopeConnection.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/78e5864e41bbf739f589b3e227f905b87e67181e/#L1 |
|
FATAL
|
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/stable/2023-06-01/networkManagerSecurityAdminConfiguration.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 2: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 3: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 4: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 5: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 6: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 7: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined') Location: azure-rest-api-specs/blob/78e5864e41bbf739f589b3e227f905b87e67181e/#L1 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PathResourceTypeNameCamelCase
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies' Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L37 |
PathResourceTypeNameCamelCase
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies' Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L83 |
PathResourceTypeNameCamelCase
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}' Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L122 |
ResourceNameRestriction
|
The resource name parameter 'policyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L122 |
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-06-01/webapplicationfirewall.json#L236 |
LroLocationHeader
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L271 |
LroErrorContent
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L283 |
MissingTypeObject
|
The schema 'WebApplicationFirewallPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L295 |
TrackedResourcePatchOperation
|
Tracked resource 'WebApplicationFirewallPolicy' must have patch operation that at least supports the update of tags. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L295 |
MissingTypeObject
|
The schema 'WebApplicationFirewallPolicyPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L315 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L325 |
MissingTypeObject
|
The schema 'WebApplicationFirewallPolicyListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L385 |
MissingTypeObject
|
The schema 'ManagedRulesDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L403 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L409 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L416 |
MissingTypeObject
|
The schema 'PolicySettings' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L425 |
MissingTypeObject
|
The schema 'WebApplicationFirewallCustomRule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L525 |
IntegerTypeMustHaveFormat
|
The integer type does not have a format, please add it. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L544 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L590 |
MissingTypeObject
|
The schema 'MatchVariable' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L638 |
MissingTypeObject
|
The schema 'MatchCondition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L668 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L676 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L780 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L800 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L854 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L874 |
MissingTypeObject
|
The schema 'OwaspCrsExclusionEntry' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L896 |
XmsIdentifierValidation
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L942 |
Not using the common-types defined parameter 'resourceGroupName'. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L49 |
|
The response of operation:'WebApplicationFirewallPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2023-06-01/webapplicationfirewall.json#L123 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
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.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
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 ssevugan21! We will review the pull request and get back to you soon. |
@ssevugan21 Please get your PR reviewed and merged by ARM team by NRP code freeze date 10/12. NRP won't help review any swagger PRs, ARM does |
/pr RequestMerge |
@microsoft-github-policy-service agree [company="{your company}"] |
@microsoft-github-policy-service agree [company="Microsoft"] |
@microsoft-github-policy-service agree company="Microsoft" |
@microsoft-github-policy-service agree company="Microsoft" |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
@Joanna-Yang-Art @rkmanda i see Swagger LintDiff check failing with errors not related to my PR commits. |
77dc103
into
Azure:release-network-Microsoft.Network-official-2023-06-01
* Adds base for updating Microsoft.Network from version stable/2023-05-01 to version 2023-06-01 * Updates readme * Updates API version in new specs and examples * Add missing DeleteBastionShareableLinkByToken API back to swagger (#25599) * add DeleteBastionShareableLinkByToken endpoint * fix location link format * Adding Developer Sku (#25887) * Firewall Policy - IDPS profiles (#25666) * add profile to put example * fixed RuleCollectionGroupWithHttpHeadersToInsert example * add profile to Policy model * description change * indentation * ListIdpsSignatures description change * direction description+enum fix * fix FirewallPolicyIDPSSignatureSeverity description * hostnames for l4 listeners (#25982) * added ergwscale support (#25969) * Fixed examples for gateway load balancer (#26058) * Add support for JSChallenge action in Application Gateway Web application Firewall (#26149) * Add support for JSChallenge action Add support for JSChallenge action in the list of supported actions for Custom rules and Managed rules * Update WafPolicyGet.json * Update WafPolicyCreateOrUpdate.json * DDoS - Fixing Swagger Validation Issues on DDoSCustomPolicy (#26248) * fixes * making changes in new api version --------- Co-authored-by: Manas Chakka <[email protected]> * [NVA] Internet Ingress Parameters (#26262) * [NVA] Internet Ingress Parameters * LintDiff Fix * Minor Fix * Added description for each of the enums for ApplicationGatewayProtocol (#26437) * Added description for each of the enums for ApplicationGatewayProtocol * Spacing for prettier checks * Remove routingConfigNfv (#25962) * remove routingConfigNfv * remove api from older versions * remove PUT nvaconnection from older versions * apply prettier check * add suppression for modelValidation * remove suppression due to approval * Fix lint errors & add supressions (#26494) * fix lint error * add supression for ResourceNameRestriction & LroErrorContent * fix example accordingly --------- Co-authored-by: htippanaboya <[email protected]> Co-authored-by: Sijie Lin <[email protected]> Co-authored-by: anvrao1 <[email protected]> Co-authored-by: NiviShenker <[email protected]> Co-authored-by: gdhillon24 <[email protected]> Co-authored-by: aneeshakella-microsoft <[email protected]> Co-authored-by: irrogozh <[email protected]> Co-authored-by: ssevugan21 <[email protected]> Co-authored-by: Manas Chakka <[email protected]> Co-authored-by: Manas Chakka <[email protected]> Co-authored-by: JainRah <[email protected]> Co-authored-by: rutuja-s <[email protected]>
* Adds base for updating Microsoft.Network from version stable/2023-05-01 to version 2023-06-01 * Updates readme * Updates API version in new specs and examples * Add missing DeleteBastionShareableLinkByToken API back to swagger (#25599) * add DeleteBastionShareableLinkByToken endpoint * fix location link format * Adding Developer Sku (#25887) * Firewall Policy - IDPS profiles (#25666) * add profile to put example * fixed RuleCollectionGroupWithHttpHeadersToInsert example * add profile to Policy model * description change * indentation * ListIdpsSignatures description change * direction description+enum fix * fix FirewallPolicyIDPSSignatureSeverity description * hostnames for l4 listeners (#25982) * added ergwscale support (#25969) * Fixed examples for gateway load balancer (#26058) * Add support for JSChallenge action in Application Gateway Web application Firewall (#26149) * Add support for JSChallenge action Add support for JSChallenge action in the list of supported actions for Custom rules and Managed rules * Update WafPolicyGet.json * Update WafPolicyCreateOrUpdate.json * DDoS - Fixing Swagger Validation Issues on DDoSCustomPolicy (#26248) * fixes * making changes in new api version --------- Co-authored-by: Manas Chakka <[email protected]> * [NVA] Internet Ingress Parameters (#26262) * [NVA] Internet Ingress Parameters * LintDiff Fix * Minor Fix * Added description for each of the enums for ApplicationGatewayProtocol (#26437) * Added description for each of the enums for ApplicationGatewayProtocol * Spacing for prettier checks * Remove routingConfigNfv (#25962) * remove routingConfigNfv * remove api from older versions * remove PUT nvaconnection from older versions * apply prettier check * add suppression for modelValidation * remove suppression due to approval * Fix lint errors & add supressions (#26494) * fix lint error * add supression for ResourceNameRestriction & LroErrorContent * fix example accordingly --------- Co-authored-by: htippanaboya <[email protected]> Co-authored-by: Sijie Lin <[email protected]> Co-authored-by: anvrao1 <[email protected]> Co-authored-by: NiviShenker <[email protected]> Co-authored-by: gdhillon24 <[email protected]> Co-authored-by: aneeshakella-microsoft <[email protected]> Co-authored-by: irrogozh <[email protected]> Co-authored-by: ssevugan21 <[email protected]> Co-authored-by: Manas Chakka <[email protected]> Co-authored-by: Manas Chakka <[email protected]> Co-authored-by: JainRah <[email protected]> Co-authored-by: rutuja-s <[email protected]>
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. 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 Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.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
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.