From 4b6774230e0be02af1aa48dbd1c6bf3eb105e835 Mon Sep 17 00:00:00 2001 From: OpenSIPS Date: Sun, 15 Dec 2024 02:50:03 +0200 Subject: [PATCH] Rebuild documentation --- modules/httpd/README | 84 +++++++++++++++++------------ modules/httpd/doc/contributors.xml | 52 +++++++++--------- modules/json/README | 85 +++++++++++++++++++----------- modules/json/doc/contributors.xml | 22 ++++---- 4 files changed, 140 insertions(+), 103 deletions(-) diff --git a/modules/httpd/README b/modules/httpd/README index b45961e2ab..9e9ddcbfe5 100644 --- a/modules/httpd/README +++ b/modules/httpd/README @@ -19,9 +19,10 @@ httpd Module 1.4.3. conn_timeout(integer) 1.4.4. buf_size (integer) 1.4.5. post_buf_size (integer) - 1.4.6. tls_cert_file (string) - 1.4.7. tls_key_file (string) - 1.4.8. tls_ciphers (string) + 1.4.6. receive_buf_size (integer) + 1.4.7. tls_cert_file (string) + 1.4.8. tls_key_file (string) + 1.4.9. tls_ciphers (string) 1.5. Exported MI Functions @@ -61,9 +62,10 @@ httpd Module 1.3. Set conn_timeout parameter 1.4. Set buf_size parameter 1.5. Set post_buf_size parameter - 1.6. Set tls_cert_file parameter - 1.7. Set tls_key_file parameter + 1.6. Set receive_buf_size parameter + 1.7. Set tls_cert_file parameter 1.8. Set tls_key_file parameter + 1.9. Set tls_key_file parameter Chapter 1. Admin Guide @@ -180,31 +182,44 @@ modparam("httpd", "buf_size", 524288) modparam("httpd", "post_buf_size", 4096) ... -1.4.6. tls_cert_file (string) +1.4.6. receive_buf_size (integer) + + It specifies the maximum length (in bytes) of the received HTTP + requests. For receiving large POST request, the default value + might require to be increased. + + The default value is 1024. + + Example 1.6. Set receive_buf_size parameter +... +modparam("httpd", "receive_buf_size", 4096) +... + +1.4.7. tls_cert_file (string) Public certificate file for httpd. It will be used as server-side certificate for incoming TLS connections. The default value is "" - Example 1.6. Set tls_cert_file parameter + Example 1.7. Set tls_cert_file parameter ... modparam("httpd", "tls_cert_file", "/etc/opensips/tls/server.pem") ... -1.4.7. tls_key_file (string) +1.4.8. tls_key_file (string) Private key of the above certificate. I must be kept in a safe place with tight permissions! The default value is "" - Example 1.7. Set tls_key_file parameter + Example 1.8. Set tls_key_file parameter ... modparam("httpd", "tls_key_file", "/etc/opensips/tls/server.key") ... -1.4.8. tls_ciphers (string) +1.4.9. tls_ciphers (string) You can specify the list of algorithms for authentication and encryption that you allow. To obtain a list of ciphers and then @@ -218,7 +233,7 @@ Warning The default value is "SECURE256:+SECURE192:-VERS-ALL:+VERS-TLS1.2" - Example 1.8. Set tls_key_file parameter + Example 1.9. Set tls_key_file parameter ... modparam("httpd", "tls_ciphers", "SECURE256:+SECURE192:-VERS-ALL:+VERS-T LS1.2") @@ -295,13 +310,13 @@ Chapter 3. Contributors 4. Bogdan-Andrei Iancu (@bogdan-iancu) 14 12 103 54 5. Vlad Patrascu (@rvlad-patrascu) 10 7 52 89 6. Ionut Ionita (@ionutrazvanionita) 8 6 65 21 - 7. Maksym Sobolyev (@sobomax) 4 2 5 5 - 8. Alexandra Titoc 4 2 2 1 - 9. Fabian Gast (@fgast) 4 1 150 3 - 10. Stephane Alnet 3 1 39 3 + 7. Vlad Paiu (@vladpaiu) 4 2 68 16 + 8. Maksym Sobolyev (@sobomax) 4 2 5 5 + 9. Alexandra Titoc 4 2 2 1 + 10. Fabian Gast (@fgast) 4 1 150 3 - All remaining contributors: Stas Kobzar, Dusan Klinec - (@ph4r05), Peter Lemenkov (@lemenkov). + All remaining contributors: Stephane Alnet, Stas Kobzar, Dusan + Klinec (@ph4r05), Peter Lemenkov (@lemenkov). (1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted @@ -323,19 +338,19 @@ Chapter 3. Contributors Table 3.2. Most recently active contributors^(1) to this module Name Commit Activity - 1. Alexandra Titoc Sep 2024 - Sep 2024 - 2. Liviu Chircu (@liviuchircu) Mar 2014 - May 2024 - 3. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023 - 4. Razvan Crainea (@razvancrainea) Mar 2015 - Oct 2021 - 5. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2013 - Aug 2021 - 6. Fabian Gast (@fgast) Aug 2020 - Aug 2020 - 7. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019 - 8. Ovidiu Sas (@ovidiusas) Jan 2012 - Jan 2019 - 9. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018 - 10. Ionut Ionita (@ionutrazvanionita) Jan 2017 - Feb 2017 - - All remaining contributors: Dusan Klinec (@ph4r05), Stas - Kobzar, Stephane Alnet. + 1. Vlad Paiu (@vladpaiu) Dec 2024 - Dec 2024 + 2. Alexandra Titoc Sep 2024 - Sep 2024 + 3. Liviu Chircu (@liviuchircu) Mar 2014 - May 2024 + 4. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023 + 5. Razvan Crainea (@razvancrainea) Mar 2015 - Oct 2021 + 6. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2013 - Aug 2021 + 7. Fabian Gast (@fgast) Aug 2020 - Aug 2020 + 8. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019 + 9. Ovidiu Sas (@ovidiusas) Jan 2012 - Jan 2019 + 10. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018 + + All remaining contributors: Ionut Ionita (@ionutrazvanionita), + Dusan Klinec (@ph4r05), Stas Kobzar, Stephane Alnet. (1) including any documentation-related commits, excluding merge commits @@ -344,10 +359,11 @@ Chapter 4. Documentation 4.1. Contributors - Last edited by: Liviu Chircu (@liviuchircu), Bogdan-Andrei - Iancu (@bogdan-iancu), Fabian Gast (@fgast), Razvan Crainea - (@razvancrainea), Peter Lemenkov (@lemenkov), Vlad Patrascu - (@rvlad-patrascu), Ovidiu Sas (@ovidiusas). + Last edited by: Vlad Paiu (@vladpaiu), Liviu Chircu + (@liviuchircu), Bogdan-Andrei Iancu (@bogdan-iancu), Fabian + Gast (@fgast), Razvan Crainea (@razvancrainea), Peter Lemenkov + (@lemenkov), Vlad Patrascu (@rvlad-patrascu), Ovidiu Sas + (@ovidiusas). Documentation Copyrights: diff --git a/modules/httpd/doc/contributors.xml b/modules/httpd/doc/contributors.xml index 28dd3e8b52..63eeeb66f5 100644 --- a/modules/httpd/doc/contributors.xml +++ b/modules/httpd/doc/contributors.xml @@ -68,6 +68,14 @@ 7. + Vlad Paiu (@vladpaiu) + 4 + 2 + 68 + 16 + + + 8. Maksym Sobolyev (@sobomax) 4 2 @@ -75,7 +83,7 @@ 5 - 8. + 9. Alexandra Titoc 4 2 @@ -83,25 +91,17 @@ 1 - 9. + 10. Fabian Gast (@fgast) 4 1 150 3 - - 10. - Stephane Alnet - 3 - 1 - 39 - 3 - -All remaining contributors: Stas Kobzar, Dusan Klinec (@ph4r05), Peter Lemenkov (@lemenkov). +All remaining contributors: Stephane Alnet, Stas Kobzar, Dusan Klinec (@ph4r05), Peter Lemenkov (@lemenkov). (1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits) @@ -128,58 +128,58 @@ 1. + Vlad Paiu (@vladpaiu) + Dec 2024 - Dec 2024 + + + 2. Alexandra Titoc Sep 2024 - Sep 2024 - 2. + 3. Liviu Chircu (@liviuchircu) Mar 2014 - May 2024 - 3. + 4. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023 - 4. + 5. Razvan Crainea (@razvancrainea) Mar 2015 - Oct 2021 - 5. + 6. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2013 - Aug 2021 - 6. + 7. Fabian Gast (@fgast) Aug 2020 - Aug 2020 - 7. + 8. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019 - 8. + 9. Ovidiu Sas (@ovidiusas) Jan 2012 - Jan 2019 - 9. + 10. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018 - - 10. - Ionut Ionita (@ionutrazvanionita) - Jan 2017 - Feb 2017 - -All remaining contributors: Dusan Klinec (@ph4r05), Stas Kobzar, Stephane Alnet. +All remaining contributors: Ionut Ionita (@ionutrazvanionita), Dusan Klinec (@ph4r05), Stas Kobzar, Stephane Alnet. (1) including any documentation-related commits, excluding merge commits @@ -190,7 +190,7 @@ Documentation
Contributors - Last edited by: Liviu Chircu (@liviuchircu), Bogdan-Andrei Iancu (@bogdan-iancu), Fabian Gast (@fgast), Razvan Crainea (@razvancrainea), Peter Lemenkov (@lemenkov), Vlad Patrascu (@rvlad-patrascu), Ovidiu Sas (@ovidiusas). + Last edited by: Vlad Paiu (@vladpaiu), Liviu Chircu (@liviuchircu), Bogdan-Andrei Iancu (@bogdan-iancu), Fabian Gast (@fgast), Razvan Crainea (@razvancrainea), Peter Lemenkov (@lemenkov), Vlad Patrascu (@rvlad-patrascu), Ovidiu Sas (@ovidiusas).
diff --git a/modules/json/README b/modules/json/README index 6abe618440..29cd6ec2f1 100644 --- a/modules/json/README +++ b/modules/json/README @@ -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) @@ -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 @@ -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 @@ -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; @@ -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]"; @@ -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)[*])) @@ -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)[*])) @@ -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"; ... @@ -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]"; @@ -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) := "[{},{},{}]"; @@ -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]"; @@ -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 84 92 2. Andrei Dragus 19 4 1556 12 3. Razvan Crainea (@razvancrainea) 14 11 48 76 4. Bogdan-Andrei Iancu (@bogdan-iancu) 8 6 27 30 @@ -426,10 +447,10 @@ Chapter 2. Contributors Table 2.2. Most recently active contributors^(1) to this module Name Commit Activity - 1. Vlad Paiu (@vladpaiu) Jul 2014 - Dec 2024 - 2. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023 - 3. Bence Szigeti Nov 2023 - Nov 2023 - 4. Liviu Chircu (@liviuchircu) Oct 2013 - Jan 2021 + 1. Liviu Chircu (@liviuchircu) Oct 2013 - Dec 2024 + 2. Vlad Paiu (@vladpaiu) Jul 2014 - Dec 2024 + 3. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023 + 4. Bence Szigeti Nov 2023 - Nov 2023 5. Razvan Crainea (@razvancrainea) Feb 2012 - Sep 2019 6. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2010 - Apr 2019 7. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019 diff --git a/modules/json/doc/contributors.xml b/modules/json/doc/contributors.xml index 0761b15786..5c06a9e305 100644 --- a/modules/json/doc/contributors.xml +++ b/modules/json/doc/contributors.xml @@ -21,10 +21,10 @@ 1. Liviu Chircu (@liviuchircu) - 19 - 16 - 50 - 89 + 20 + 17 + 84 + 92 2. @@ -128,24 +128,24 @@ 1. + Liviu Chircu (@liviuchircu) + Oct 2013 - Dec 2024 + + + 2. Vlad Paiu (@vladpaiu) Jul 2014 - Dec 2024 - 2. + 3. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023 - 3. + 4. Bence Szigeti Nov 2023 - Nov 2023 - - 4. - Liviu Chircu (@liviuchircu) - Oct 2013 - Jan 2021 - 5. Razvan Crainea (@razvancrainea)