Another update to proxy configuration API

[framework/connectivity/connman.git] / doc / service-api.txt

diff --git a/doc/service-api.txt b/doc/service-api.txt
index 0e06da5..8599041 100644 (file)
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -399,26 +399,65 @@ Properties        string State [readonly]
 
                        string Method [readonly]
 
-                               Possible values are "direct", "auto",
-                               "manual" and "auto-config".
+                               Possible values are "direct", "auto" and
+                               "manual".
+
+                               If the DHCP server, or WPAD protocol, provides
+                               an automatic configuration URL, then this value
+                               is set to "auto" in case "auto" is configured"
+                               referenced by the URL value. If "auto" is
+                               configured and DHCP and WPAD auto-discover
+                               methods fails then method will be "direct".
+
+                               In case of "auto" method, the URL file has
+                               to be provided. In case of "direct" no
+                               additional information are provided. For
+                               the "manual" method the Servers have to
+                               be set.
 
-                               If the DHCP server provides an automatic
-                               configuration URL, then this value is set
-                               to "auto-config". The PAC file will be
-                               referenced by the URL value.
+                       string URL [readonly]
 
-                               If no automatic configuration is available,
-                               then "direct" is set.
+                               Automatic proxy configuration URL. Used by
+                               "auto" method.
 
-                               The values "auto" and "manual" are not yet
-                               supported.
+                       array{string} Servers [readonly]
 
-                       string URL [readonly]
+                               Used when "manual" method is set.
+
+                               List of proxy URIs. The URI without a protocol
+                               will be interpreted as the generic proxy URI.
+                               All others will target a specific protocol and
+                               only once.
+
+                               Example for generic proxy server entry would
+                               be like this: "server.example.com:911".
 
-                               Automatic proxy configuration URL.
+                       array{string} Excludes [readonly]
+
+                               Used when "manual" method is set.
+
+                               List of hosts which can be accessed directly.
+
+               dict Proxy.Configuration [readwrite]
+
+                       Same values as Proxy property. The Proxy represents
+                       the actual system configuration while this allows
+                       user configuration.
+
+                       If "auto" method is set with an empty URL, then
+                       WPAD protocol will be ran. Otherwise the specified
+                       URL will be used.
 
                dict Provider [readonly]
 
+                       string Host [readonly]
+
+                              VPN host IP.
+
+                       string Domain [readonly]
+
+                              VPN Domain.
+
                        string Name [readonly]
 
                               VPN provider Name.