summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTomasz Bursztyka <tomasz.bursztyka@linux.intel.com>2012-06-25 10:16:37 (GMT)
committerPatrik Flykt <patrik.flykt@linux.intel.com>2012-06-26 09:52:00 (GMT)
commita3e24ecbba6aa21bbe496c662e96c4b620e76ac9 (patch)
tree78b23e2ed37c5799f5b4a7dde109bb224ca2a982 /doc
parent4b96f83edbbdee63a6ef03e8d3e0d87f536acb31 (diff)
downloadconnman-a3e24ecbba6aa21bbe496c662e96c4b620e76ac9.tar.gz
connman-a3e24ecbba6aa21bbe496c662e96c4b620e76ac9.tar.xz
doc: Document 'informational' value of Requirement field
Diffstat (limited to 'doc')
-rw-r--r--doc/agent-api.txt19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index 8201ac1..91371af 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