summaryrefslogtreecommitdiffstats
path: root/browser/extensions/webcompat/experiment-apis/trackingProtection.json
blob: 2627d1ea0f3c48da7d533f865366a8227d1c5aff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
[
  {
    "namespace": "trackingProtection",
    "description": "experimental API allow requests through ETP",
    "functions": [
      {
        "name": "allow",
        "type": "function",
        "description": "Add specific requests to a given allow-list",
        "parameters": [
          {
            "name": "allowlistId",
            "type": "string"
          },
          {
            "name": "patterns",
            "description": "Array of match patterns",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          {
            "name": "options",
            "type": "object",
            "optional": true,
            "properties": {
              "hosts": {
                "description": "Hosts to limit this bypass to (optional)",
                "type": "array",
                "items": {
                  "type": "string"
                },
                "optional": true
              },
              "notHosts": {
                "description": "Hosts to not allow this bypass for (optional)",
                "type": "array",
                "items": {
                  "type": "string"
                },
                "optional": true
              }
            }
          }
        ],
        "async": true
      },
      {
        "name": "revoke",
        "type": "function",
        "description": "Revokes the given allow-list",
        "parameters": [
          {
            "name": "allowListId",
            "type": "string"
          }
        ],
        "async": true
      },
      {
        "name": "wasRequestUnblocked",
        "type": "function",
        "description": "Whether the given requestId was unblocked by any allowList",
        "parameters": [
          {
            "name": "requestId",
            "type": "string"
          }
        ],
        "async": true
      }
    ]
  }
]