[sr-dev] git:master:6a641001: json: docs - more details about the result of json_get_field()

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 6a64100105e7ac0ae8a952a2e3770d7534615796
URL: https://github.com/kamailio/kamailio/commit/6a64100105e7ac0ae8a952a2e3770d7534615796

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-02-27T13:10:19+01:00

json: docs - more details about the result of json_get_field()

- reported by GH #1542

---

Modified: src/modules/json/doc/json_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/6a64100105e7ac0ae8a952a2e3770d7534615796.diff
Patch: https://github.com/kamailio/kamailio/commit/6a64100105e7ac0ae8a952a2e3770d7534615796.patch

---

diff --git a/src/modules/json/doc/json_admin.xml b/src/modules/json/doc/json_admin.xml
index 41d19f63b1..d510090285 100644
--- a/src/modules/json/doc/json_admin.xml
+++ b/src/modules/json/doc/json_admin.xml
@@ -63,6 +63,12 @@
 	    <para>
 		Copy field 'field_name' from json object 'json_string' and store it in pvar 'destination'.
 		</para>
+		<para>
+		Note that the result is the string representation of that JSON filed.
+		For example, if you want to retrieve a field that has a string value,
+		then the result is the value enclosed in quotes. If the field value is a structure,
+		then the result is the string-formatted representation of that structure.
+		</para>
 		<example>
 		<title><function>json_get_field</function> usage</title>
 		<programlisting format="linespecific">