OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 [ | 5 [ |
6 { | 6 { |
7 "namespace": "proxy", | 7 "namespace": "proxy", |
8 "description": "Use the <code>chrome.proxy</code> API to manage Chrome's pro
xy settings. This API relies on the <a href='types#ChromeSetting'>ChromeSetting
prototype of the type API</a> for getting and setting the proxy configuration.", | 8 "description": "Use the <code>chrome.proxy</code> API to manage Chrome's pro
xy settings. This API relies on the <a href='types#ChromeSetting'>ChromeSetting
prototype of the type API</a> for getting and setting the proxy configuration.", |
9 "types": [ | 9 "types": [ |
10 { | 10 { |
| 11 "id": "Scheme", |
| 12 "type": "string", |
| 13 "enum": ["http", "https", "quic", "socks4", "socks5"] |
| 14 }, |
| 15 { |
| 16 "id": "Mode", |
| 17 "type": "string", |
| 18 "enum": ["direct", "auto_detect", "pac_script", "fixed_servers", "system
"] |
| 19 }, |
| 20 { |
11 "id": "ProxyServer", | 21 "id": "ProxyServer", |
12 "type": "object", | 22 "type": "object", |
13 "description": "An object encapsulating a single proxy server's specific
ation.", | 23 "description": "An object encapsulating a single proxy server's specific
ation.", |
14 "properties": { | 24 "properties": { |
15 "scheme": {"type": "string", "optional": true, "enum": ["http", "https
", "quic", "socks4", "socks5"], "description": "The scheme (protocol) of the pro
xy server itself. Defaults to 'http'."}, | 25 "scheme": {"$ref": "Scheme", "optional": true, "description": "The sch
eme (protocol) of the proxy server itself. Defaults to 'http'."}, |
16 "host": {"type": "string", "description": "The URI of the proxy server
. This must be an ASCII hostname (in Punycode format). IDNA is not supported, ye
t."}, | 26 "host": {"type": "string", "description": "The URI of the proxy server
. This must be an ASCII hostname (in Punycode format). IDNA is not supported, ye
t."}, |
17 "port": {"type": "integer", "optional": true, "description": "The port
of the proxy server. Defaults to a port that depends on the scheme."} | 27 "port": {"type": "integer", "optional": true, "description": "The port
of the proxy server. Defaults to a port that depends on the scheme."} |
18 } | 28 } |
19 }, | 29 }, |
20 { | 30 { |
21 "id": "ProxyRules", | 31 "id": "ProxyRules", |
22 "type": "object", | 32 "type": "object", |
23 "description": "An object encapsulating the set of proxy rules for all p
rotocols. Use either 'singleProxy' or (a subset of) 'proxyForHttp', 'proxyForHtt
ps', 'proxyForFtp' and 'fallbackProxy'.", | 33 "description": "An object encapsulating the set of proxy rules for all p
rotocols. Use either 'singleProxy' or (a subset of) 'proxyForHttp', 'proxyForHtt
ps', 'proxyForFtp' and 'fallbackProxy'.", |
24 "properties": { | 34 "properties": { |
25 "singleProxy": {"$ref": "ProxyServer", "optional": true, "description"
: "The proxy server to be used for all per-URL requests (that is http, https, an
d ftp)."}, | 35 "singleProxy": {"$ref": "ProxyServer", "optional": true, "description"
: "The proxy server to be used for all per-URL requests (that is http, https, an
d ftp)."}, |
(...skipping 15 matching lines...) Expand all Loading... |
41 } | 51 } |
42 }, | 52 }, |
43 { | 53 { |
44 "id": "ProxyConfig", | 54 "id": "ProxyConfig", |
45 "type": "object", | 55 "type": "object", |
46 "description": "An object encapsulating a complete proxy configuration."
, | 56 "description": "An object encapsulating a complete proxy configuration."
, |
47 "properties": { | 57 "properties": { |
48 "rules": {"$ref": "ProxyRules", "optional": true, "description": "The
proxy rules describing this configuration. Use this for 'fixed_servers' mode."}, | 58 "rules": {"$ref": "ProxyRules", "optional": true, "description": "The
proxy rules describing this configuration. Use this for 'fixed_servers' mode."}, |
49 "pacScript": {"$ref": "PacScript", "optional": true, "description": "T
he proxy auto-config (PAC) script for this configuration. Use this for 'pac_scri
pt' mode."}, | 59 "pacScript": {"$ref": "PacScript", "optional": true, "description": "T
he proxy auto-config (PAC) script for this configuration. Use this for 'pac_scri
pt' mode."}, |
50 "mode": { | 60 "mode": { |
51 "type": "string", | 61 "$ref": "Mode", |
52 "enum": ["direct", "auto_detect", "pac_script", "fixed_servers", "sy
stem"], | |
53 "description": "'direct' = Never use a proxy<br>'auto_detect' = Auto
detect proxy settings<br>'pac_script' = Use specified PAC script<br>'fixed_serv
ers' = Manually specify proxy servers<br>'system' = Use system proxy settings" | 62 "description": "'direct' = Never use a proxy<br>'auto_detect' = Auto
detect proxy settings<br>'pac_script' = Use specified PAC script<br>'fixed_serv
ers' = Manually specify proxy servers<br>'system' = Use system proxy settings" |
54 } | 63 } |
55 } | 64 } |
56 } | 65 } |
57 ], | 66 ], |
58 "properties": { | 67 "properties": { |
59 "settings": { | 68 "settings": { |
60 "$ref": "types.ChromeSetting", | 69 "$ref": "types.ChromeSetting", |
61 "description": "Proxy settings to be used. The value of this setting is
a ProxyConfig object.", | 70 "description": "Proxy settings to be used. The value of this setting is
a ProxyConfig object.", |
62 "value": [ | 71 "value": [ |
(...skipping 24 matching lines...) Expand all Loading... |
87 "type": "string", | 96 "type": "string", |
88 "description": "Additional details about the error such as a Jav
aScript runtime error." | 97 "description": "Additional details about the error such as a Jav
aScript runtime error." |
89 } | 98 } |
90 } | 99 } |
91 } | 100 } |
92 ] | 101 ] |
93 } | 102 } |
94 ] | 103 ] |
95 } | 104 } |
96 ] | 105 ] |
OLD | NEW |