Skip to content

Commit

Permalink
Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@opensips-github
opensips-github committed Dec 14, 2024
1 parent 2ab7e9e commit d721132
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 41 deletions.
83 changes: 52 additions & 31 deletions modules/json/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ JSON Module
1.2.2. External Libraries or Applications

1.3. Exported Parameters

1.3.1. enable_long_quoting (boolean)

1.4. Exported Pseudo-Variables

1.4.1. $json(id)
Expand Down Expand Up @@ -40,19 +43,20 @@ JSON Module

List of Examples

1.1. Accessing the $json variable
1.2. Iterating through an array using variables
1.3. iteration over $json object keys
1.4. iteration over $json object values
1.5. iteration over $json array values
1.6. Appending integers to arrays
1.7. Deleting the last element in an array
1.8. Adding a string value to a json object
1.9. Initializing an array
1.10. Setting a boolean or null value
1.11. Adding a json to another json
1.12. Creating a reference
1.13. [LOGICAL ERROR] Creating a circular reference
1.1. Set enable_long_quoting parameter
1.2. Accessing the $json variable
1.3. Iterating through an array using variables
1.4. iteration over $json object keys
1.5. iteration over $json object values
1.6. iteration over $json array values
1.7. Appending integers to arrays
1.8. Deleting the last element in an array
1.9. Adding a string value to a json object
1.10. Initializing an array
1.11. Setting a boolean or null value
1.12. Adding a json to another json
1.13. Creating a reference
1.14. [LOGICAL ERROR] Creating a circular reference

Chapter 1. Admin Guide

Expand Down Expand Up @@ -86,7 +90,24 @@ Chapter 1. Admin Guide

1.3. Exported Parameters

The module does not export any parameters.
1.3.1. enable_long_quoting (boolean)

Enable this parameter if your input JSONs contain signed
integers which do not fit into 4 bytes (e.g. larger than
2147483647, etc.). If the parameter is enabled, 4-byte integers
will continue to be returned as integers, while larger values
will be returned as strings, in order to avoid the integer
overflow.

Default value is false.

Example 1.1. Set enable_long_quoting parameter
...
modparam("json", "enable_long_quoting", true)
...
# normalize the "gateway_id" int/string value to be always a string
$var(gateway_id) = "" + $json(body/gateway_id);
...

1.4. Exported Pseudo-Variables

Expand Down Expand Up @@ -139,7 +160,7 @@ Chapter 1. Admin Guide
printed in the log describing the value of the json and the
path used

Example 1.1. Accessing the $json variable
Example 1.2. Accessing the $json variable
...
$json(obj1/key) = "value"; #replace or insert the (key,value)
#pair into the json object;
Expand All @@ -152,7 +173,7 @@ xlog("$json(name/key1[0][-1]/key2)"); # a more complex example

...

Example 1.2. Iterating through an array using variables
Example 1.3. Iterating through an array using variables
...

$json(ar1) := "[1,2,3,4]";
Expand Down Expand Up @@ -188,14 +209,14 @@ while( $json(ar1[$var(i)]) )
values, you can use the .keys or .values suffix for the path
specified in the id.

Example 1.3. iteration over $json object keys
Example 1.4. iteration over $json object keys
...
$json(foo) := "{\"a\": 1, \"b\": 2, \"c\": 3}";
for ($var(k) in $(json(foo.keys)[*]))
xlog("$var(k) ");
...

Example 1.4. iteration over $json object values
Example 1.5. iteration over $json object values
...
$json(foo) := "{\"a\": 1, \"b\": 2, \"c\": 3}";
for ($var(v) in $(json(foo.values)[*]))
Expand All @@ -208,7 +229,7 @@ for ($var(v) in $(json(foo)[*]))
xlog("$var(v) ");
...

Example 1.5. iteration over $json array values
Example 1.6. iteration over $json array values
...
$json(foo) := "[1, 2, 3]";
for ($var(v) in $(json(foo)[*]))
Expand Down Expand Up @@ -243,17 +264,17 @@ for ($var(v) in $(json(foo)[*]))

Setting a value to NULL will cause it to be deleted.

Example 1.6. Appending integers to arrays
Example 1.7. Appending integers to arrays
...
$json(array1[]) = 1;
...

Example 1.7. Deleting the last element in an array
Example 1.8. Deleting the last element in an array
...
$json(array1[-1]) = NULL;
...

Example 1.8. Adding a string value to a json object
Example 1.9. Adding a string value to a json object
...
$json(object1/some_key) = "some_value";
...
Expand All @@ -264,19 +285,19 @@ $json(object1/some_key) = "some_value";
object ( e.g. this operator should be used to parse json inputs
).

Example 1.9. Initializing an array
Example 1.10. Initializing an array
...
$json(array1) := "[]";
...

Example 1.10. Setting a boolean or null value
Example 1.11. Setting a boolean or null value
...
$json(array1[]) := "null";
$json(array1[]) := "true";
$json(array1[]) := "false";
...

Example 1.11. Adding a json to another json
Example 1.12. Adding a json to another json
...

$json(array) := "[1,2,3]";
Expand Down Expand Up @@ -323,7 +344,7 @@ $json(object/array) := $json(array) ;
accidentally create a circular reference and try to get the
value from the object you will crash OPENSIPS.

Example 1.12. Creating a reference
Example 1.13. Creating a reference
...

$json(b) := "[{},{},{}]";
Expand Down Expand Up @@ -368,7 +389,7 @@ Test link :

...

Example 1.13. [LOGICAL ERROR] Creating a circular reference
Example 1.14. [LOGICAL ERROR] Creating a circular reference
...

$json(b) := "[1]";
Expand All @@ -392,7 +413,7 @@ Chapter 2. Contributors
Table 2.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Liviu Chircu (@liviuchircu) 19 16 50 89
1. Liviu Chircu (@liviuchircu) 20 17 93 94
2. Andrei Dragus 18 4 1556 12
3. Razvan Crainea (@razvancrainea) 15 12 49 78
4. Bogdan-Andrei Iancu (@bogdan-iancu) 8 6 27 30
Expand Down Expand Up @@ -426,9 +447,9 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) Feb 2012 - Nov 2023
2. Maksym Sobolyev (@sobomax) Jan 2021 - Feb 2023
3. Liviu Chircu (@liviuchircu) Oct 2013 - Jan 2021
1. Liviu Chircu (@liviuchircu) Oct 2013 - Dec 2024
2. Razvan Crainea (@razvancrainea) Feb 2012 - Nov 2023
3. Maksym Sobolyev (@sobomax) Jan 2021 - Feb 2023
4. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2010 - Apr 2019
5. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
6. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
Expand Down
20 changes: 10 additions & 10 deletions modules/json/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">19</entry>
<entry align="center">16</entry>
<entry align="center">50</entry>
<entry align="center">89</entry>
<entry align="center">20</entry>
<entry align="center">17</entry>
<entry align="center">93</entry>
<entry align="center">94</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -128,18 +128,18 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Feb 2012 - Nov 2023</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Oct 2013 - Dec 2024</entry>
</row>
<row>
<entry>2. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Jan 2021 - Feb 2023</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Feb 2012 - Nov 2023</entry>
</row>
<row>
<entry>3. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Oct 2013 - Jan 2021</entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Jan 2021 - Feb 2023</entry>
</row>
<row>
<entry>4. </entry>
Expand Down

0 comments on commit d721132

Please sign in to comment.