diff options
| author | Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com> | 2012-06-25 13:16:37 +0300 |
|---|---|---|
| committer | Patrik Flykt <patrik.flykt@linux.intel.com> | 2012-06-26 12:52:00 +0300 |
| commit | a3e24ecbba6aa21bbe496c662e96c4b620e76ac9 (patch) | |
| tree | 78b23e2ed37c5799f5b4a7dde109bb224ca2a982 /doc | |
| parent | 4b96f83edbbdee63a6ef03e8d3e0d87f536acb31 (diff) | |
| download | connman-a3e24ecbba6aa21bbe496c662e96c4b620e76ac9.tar.gz connman-a3e24ecbba6aa21bbe496c662e96c4b620e76ac9.tar.bz2 connman-a3e24ecbba6aa21bbe496c662e96c4b620e76ac9.zip | |
doc: Document 'informational' value of Requirement field
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/agent-api.txt | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/agent-api.txt b/doc/agent-api.txt index 8201ac15..91371af4 100644 --- a/doc/agent-api.txt +++ b/doc/agent-api.txt @@ -118,14 +118,14 @@ Fields string Name Arguments string Type Contains the type of a field. For example "psk", "wep" - "informational", "passphrase", "response", "ssid", - "wpspin" or plain "string". "informational" has no - "Requirement" but a "Value". + "passphrase", "response", "ssid", "wpspin" or plain + "string". string Requirement Contains the requirement option. Valid values are - "mandatory", "optional" or "alternate". + "mandatory", "optional", "alternate" or + "informational". The "alternate" value specifies that this field can be returned as an alternative to another one. An example @@ -134,6 +134,10 @@ Arguments string Type All "mandatory" fields must be returned, while the "optional" can be returned if available. + Nothing needs to be returned for "informational", as it + is here only to provide an information so a value is + attached to it. + array{string} Alternates Contains the list of alternate field names this @@ -160,9 +164,10 @@ Examples Requesting a passphrase for WPA2 network "Requirement" : "mandatory" }, "PreviousPassphrase" : - { "Type" : "informational", - "Value" : "secret123" - } + { "Type" : "psk", + "Requirement : "informational", + "Value" : "secret123" + } } Requesting name for hidden network |