Add support for State flag in Custom Rule #22457
Merged
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
|
Hi, @tejasshah7 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| webapplicationfirewall.json | 2022-09-01(462e60d) | 2022-07-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version is removing enum value(s) 'Standard_Basic' from the old version. New: Microsoft.Network/stable/2022-09-01/applicationGateway.json#L1285:9 Old: Microsoft.Network/stable/2022-07-01/applicationGateway.json#L1285:9 |
|
The new version is removing enum value(s) 'Standard_Basic' from the old version. New: Microsoft.Network/stable/2022-09-01/applicationGateway.json#L1302:9 Old: Microsoft.Network/stable/2022-07-01/applicationGateway.json#L1303:9 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-09 | package-2022-09(462e60d) | package-2022-09(release-Microsoft.Network-2022-09-01) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies' Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L37 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies' Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L83 |
|
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}' Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L122 |
|
The resource name parameter 'policyName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L122 |
|
Tracked resource 'WebApplicationFirewallPolicy' must have patch operation that at least supports the update of tags. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L122 |
|
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L271 |
|
The schema 'WebApplicationFirewallPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L295 |
|
Model definition 'WebApplicationFirewallPolicy' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L295 |
|
The schema 'WebApplicationFirewallPolicyPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L315 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L325 |
|
The schema 'WebApplicationFirewallPolicyListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L385 |
|
The schema 'ManagedRulesDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L403 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L409 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L416 |
|
The schema 'PolicySettings' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L425 |
|
The schema 'WebApplicationFirewallCustomRule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L484 |
|
The integer type does not have a format, please add it. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L503 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L531 |
|
The schema 'MatchVariable' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L570 |
|
The schema 'MatchCondition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L600 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L608 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L673 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L693 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L747 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L767 |
|
The schema 'OwaspCrsExclusionEntry' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L789 |
|
Missing identifier id in array item property Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L835 |
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L49 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L95 |
|
| The response of operation:'WebApplicationFirewallPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Network/stable/2022-09-01/webapplicationfirewall.json#L123 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️CadlAPIView 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.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
ghost
added
the
Generated ApiView
|
|
Here is the Swagger review PR that ARM had already signed off for private branch: |
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @tejasshah7, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
|
Hi @tejasshah7, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Feb 4, 2023
Closed
tejasshah7
force-pushed
the
tesha/WafCustomRuleEnableFlag
branch
from
4cd3541 to
9605a1c
Compare
This was referenced Feb 4, 2023
tejasshah7
force-pushed
the
tesha/WafCustomRuleEnableFlag
branch
from
9605a1c to
462e60d
Compare
raych1
approved these changes
Feb 7, 2023
|
Breaking change is not caused by this PR. |
raych1
added
the
Approved-BreakingChange
akning-ms
pushed a commit
that referenced
this pull request
Feb 22, 2023
* Adds base for updating Microsoft.Network from version stable/2022-07-01 to version 2022-09-01 * Updates readme * Updates API version in new specs and examples * Added flowlog property in virtual network (#21790) Co-authored-by: Krishna Mishra <[email protected]> * commit1 (#22111) Co-authored-by: Khushboo Baheti <[email protected]> * adding auth status property to circuit (#22024) * Make auth status readonly (#22365) * make auth status read only * fixing model validation * prettier fix * Add support for State flag in Custom Rule (#22457) * Fix LRO header model validation (#22506) * Add new status code for application gateway custom error page (#22151) * Add new status code for application gateway custom error page * Fix prettier * Adding words to Custom-Words list * Fix missing resource id in application gateway list example (#22509) * Resolving merge conflicts with main branch --------- Co-authored-by: Mikhail <[email protected]> Co-authored-by: KRISHNA MISHRA <[email protected]> Co-authored-by: Krishna Mishra <[email protected]> Co-authored-by: Khushboo Baheti <[email protected]> Co-authored-by: Khushboo Baheti <[email protected]> Co-authored-by: utbarn-ms <[email protected]> Co-authored-by: tejasshah7 <[email protected]> Co-authored-by: Prateek Sachan <[email protected]>
11 tasks
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
* Adds base for updating Microsoft.Network from version stable/2022-07-01 to version 2022-09-01 * Updates readme * Updates API version in new specs and examples * Added flowlog property in virtual network (Azure#21790) Co-authored-by: Krishna Mishra <[email protected]> * commit1 (Azure#22111) Co-authored-by: Khushboo Baheti <[email protected]> * adding auth status property to circuit (Azure#22024) * Make auth status readonly (Azure#22365) * make auth status read only * fixing model validation * prettier fix * Add support for State flag in Custom Rule (Azure#22457) * Fix LRO header model validation (Azure#22506) * Add new status code for application gateway custom error page (Azure#22151) * Add new status code for application gateway custom error page * Fix prettier * Adding words to Custom-Words list * Fix missing resource id in application gateway list example (Azure#22509) * Resolving merge conflicts with main branch --------- Co-authored-by: Mikhail <[email protected]> Co-authored-by: KRISHNA MISHRA <[email protected]> Co-authored-by: Krishna Mishra <[email protected]> Co-authored-by: Khushboo Baheti <[email protected]> Co-authored-by: Khushboo Baheti <[email protected]> Co-authored-by: utbarn-ms <[email protected]> Co-authored-by: tejasshah7 <[email protected]> Co-authored-by: Prateek Sachan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.