Commit 87e73be1 authored by Karan Bhatia's avatar Karan Bhatia Committed by Commit Bot

DNR: Add some documentation for allowAllRequests rules.

More documentation/examples will follow once the documentation for generic
priority lands.

BUG=1038831

Change-Id: I88cf351a6c327c6dbcf8554cf71a17ee82b06933
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2001755
Commit-Queue: Karan Bhatia <karandeepb@chromium.org>
Reviewed-by: default avatarDevlin <rdevlin.cronin@chromium.org>
Cr-Commit-Position: refs/heads/master@{#734329}
parent 614708c6
...@@ -337,6 +337,7 @@ are true: ...@@ -337,6 +337,7 @@ are true:
</pre> </pre>
<ul> <ul>
<!--TODO(crbug.com/1038831): Add examples for allowAllRequests rules. -->
<li> <li>
Consider a navigation to <code>"http://google.com"</code>. Rules with id (1) Consider a navigation to <code>"http://google.com"</code>. Rules with id (1)
and (3) match. The request will be blocked because blocking rules have and (3) match. The request will be blocked because blocking rules have
......
...@@ -54,9 +54,8 @@ namespace declarativeNetRequest { ...@@ -54,9 +54,8 @@ namespace declarativeNetRequest {
upgradeScheme, upgradeScheme,
// Remove request/response headers from the network request. // Remove request/response headers from the network request.
removeHeaders, removeHeaders,
// TODO(crbug.com/1038831): Add documentation once the implementation is // Allow all requests within a frame hierarchy, including the frame request
// complete. // itself.
[nodoc]
allowAllRequests allowAllRequests
}; };
...@@ -182,6 +181,10 @@ namespace declarativeNetRequest { ...@@ -182,6 +181,10 @@ namespace declarativeNetRequest {
// List of resource types which the rule can match. An empty list is not // List of resource types which the rule can match. An empty list is not
// allowed. // allowed.
//
// Note: this must be specified for <code>allowAllRequests</code> rules and
// may only include the <code>sub_frame</code> and <code>main_frame</code>
// resource types.
ResourceType[]? resourceTypes; ResourceType[]? resourceTypes;
// List of resource types which the rule won't match. Only one of // List of resource types which the rule won't match. Only one of
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment