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 Feb 12, 2022
1 parent 09490cb commit 9afb666
Show file tree
Hide file tree
Showing 24 changed files with 301 additions and 166 deletions.
4 changes: 2 additions & 2 deletions modules/auth_jwt/README
View file
Expand Up @@ -362,7 +362,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. Vlad Paiu (@vladpaiu) 15 3 1317 16
1. Vlad Paiu (@vladpaiu) 18 4 1519 16
2. Bogdan-Andrei Iancu (@bogdan-iancu) 4 2 6 7

(1) DevScore = author_commits + author_lines_added /
Expand All @@ -385,7 +385,7 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Paiu (@vladpaiu) Mar 2020 - Jan 2022
1. Vlad Paiu (@vladpaiu) Mar 2020 - Feb 2022
2. Bogdan-Andrei Iancu (@bogdan-iancu) Mar 2020 - Dec 2021

(1) including any documentation-related commits, excluding
Expand Down
8 changes: 4 additions & 4 deletions modules/auth_jwt/doc/contributors.xml
View file
Expand Up @@ -21,9 +21,9 @@
<row>
<entry>1. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">15</entry>
<entry align="center">3</entry>
<entry align="center">1317</entry>
<entry align="center">18</entry>
<entry align="center">4</entry>
<entry align="center">1519</entry>
<entry align="center">16</entry>
</row>
<row>
Expand Down Expand Up @@ -65,7 +65,7 @@
<row>
<entry>1. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">Mar 2020 - Jan 2022</entry>
<entry align="center">Mar 2020 - Feb 2022</entry>
</row>
<row>
<entry>2. </entry>
Expand Down
18 changes: 16 additions & 2 deletions modules/b2b_logic/README
View file
Expand Up @@ -62,6 +62,7 @@ B2B_LOGIC
1.6.1. b2b_trigger_scenario
1.6.2. b2b_bridge
1.6.3. b2b_list
1.6.4. b2b_terminate_call

1.7. Exported Pseudo-Variables

Expand Down Expand Up @@ -848,6 +849,19 @@ nsips.org
MI FIFO Command Format:
opensips-cli -x mi b2b_list

1.6.4. b2b_terminate_call

Terminates an ongoing B2B session.

Name: b2b_terminate_call

Parameters:
* key : the b2b_logic key or the callid;from-tag;to-tag of
one of call legs of the ongoing session.

MI FIFO Command Format:
opensips-cli -x mi b2b_terminate_call 159.0

1.7. Exported Pseudo-Variables

1.7.1. $b2b_logic.key
Expand Down Expand Up @@ -1119,7 +1133,7 @@ Chapter 3. Contributors
Table 3.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Vlad Patrascu (@rvlad-patrascu) 86 21 2906 2459
1. Vlad Patrascu (@rvlad-patrascu) 88 22 2964 2464
2. Nick Altmann (@nikbyte) 13 9 278 29
3. Bogdan-Andrei Iancu (@bogdan-iancu) 5 3 49 11
4. Maksym Sobolyev (@sobomax) 4 2 21 21
Expand Down Expand Up @@ -1148,7 +1162,7 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Patrascu (@rvlad-patrascu) Nov 2020 - Jan 2022
1. Vlad Patrascu (@rvlad-patrascu) Nov 2020 - Feb 2022
2. Aron Podrigal (@ar45) Nov 2021 - Nov 2021
3. Razvan Crainea (@razvancrainea) Jan 2021 - Jul 2021
4. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2021 - May 2021
Expand Down
10 changes: 5 additions & 5 deletions modules/b2b_logic/doc/contributors.xml
View file
Expand Up @@ -21,10 +21,10 @@
<row>
<entry>1. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">86</entry>
<entry align="center">21</entry>
<entry align="center">2906</entry>
<entry align="center">2459</entry>
<entry align="center">88</entry>
<entry align="center">22</entry>
<entry align="center">2964</entry>
<entry align="center">2464</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -113,7 +113,7 @@
<row>
<entry>1. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">Nov 2020 - Jan 2022</entry>
<entry align="center">Nov 2020 - Feb 2022</entry>
</row>
<row>
<entry>2. </entry>
Expand Down
35 changes: 29 additions & 6 deletions modules/cachedb_local/README
View file
Expand Up @@ -19,6 +19,7 @@ cachedb_local Module
1.4.3. cache_clean_period (int)
1.4.4. cluster_id (int)
1.4.5. cluster_persistency (string)
1.4.6. enable_restart_persistency (int)

1.5. Exported Functions

Expand Down Expand Up @@ -52,7 +53,8 @@ cachedb_local Module
1.3. Set cache_clean_period parameter
1.4. Setting the cluster_id parameter
1.5. Set cluster_persistency parameter
1.6. cache_remove_chunk usage
1.6. Set enable_restart_persistency parameter
1.7. cache_remove_chunk usage

Chapter 1. Admin Guide

Expand Down Expand Up @@ -226,6 +228,27 @@ modparam("cachedb_local", "cluster_id", 1)
modparam("cachedb_local", "cluster_persistency", "sync-from-cluster")
...

1.4.6. enable_restart_persistency (int)

Enable restart persistency using the persistent memory
mechanism. Data is stored in a cache file that is mapped
against OpenSIPS memory.

Note that you have to keep the same collection definitions from
a previous run in order to use the cached data for the
respective collections.

If cluster persistency is enabled as well, keys loaded from the
persistent cache will be discarded if they are not received in
the cluster sync data.

Default value is “0 (disabled)”.

Example 1.6. Set enable_restart_persistency parameter
...
modparam("cachedb_local", "enable_restart_persistency", yes)
...

1.5. Exported Functions

1.5.1. cache_remove_chunk([collection,] glob)
Expand All @@ -242,7 +265,7 @@ modparam("cachedb_local", "cluster_persistency", "sync-from-cluster")

This function can be used from all routes

Example 1.6. cache_remove_chunk usage
Example 1.7. cache_remove_chunk usage
...
cache_remove_chunk("myinfo_*");
cache_remove_chunk("collection1", "myinfo_*");
Expand Down Expand Up @@ -286,8 +309,8 @@ Chapter 3. Contributors
Name DevScore Commits Lines ++ Lines --
1. Vlad Paiu (@vladpaiu) 32 10 1155 693
2. Liviu Chircu (@liviuchircu) 21 15 126 190
3. Bogdan-Andrei Iancu (@bogdan-iancu) 16 14 46 50
4. Vlad Patrascu (@rvlad-patrascu) 16 11 147 132
3. Vlad Patrascu (@rvlad-patrascu) 21 12 494 204
4. Bogdan-Andrei Iancu (@bogdan-iancu) 16 14 46 50
5. Anca Vamanu 13 5 739 54
6. Andrei Dragus 9 4 182 181
7. Fabian Gast (@fgast) 9 3 517 48
Expand Down Expand Up @@ -319,8 +342,8 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Mar 2014 - Dec 2021
2. Vlad Patrascu (@rvlad-patrascu) Jan 2017 - Sep 2021
1. Vlad Patrascu (@rvlad-patrascu) Jan 2017 - Feb 2022
2. Liviu Chircu (@liviuchircu) Mar 2014 - Dec 2021
3. Maksym Sobolyev (@sobomax) Jan 2021 - Jan 2021
4. Zero King (@l2dy) Mar 2020 - Mar 2020
5. Peter Lemenkov (@lemenkov) Jun 2018 - Feb 2020
Expand Down
24 changes: 12 additions & 12 deletions modules/cachedb_local/doc/contributors.xml
View file
Expand Up @@ -36,20 +36,20 @@
</row>
<row>
<entry>3. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">21</entry>
<entry align="center">12</entry>
<entry align="center">494</entry>
<entry align="center">204</entry>
</row>
<row>
<entry>4. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">16</entry>
<entry align="center">14</entry>
<entry align="center">46</entry>
<entry align="center">50</entry>
</row>
<row>
<entry>4. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">16</entry>
<entry align="center">11</entry>
<entry align="center">147</entry>
<entry align="center">132</entry>
</row>
<row>
<entry>5. </entry>
<entry>Anca Vamanu</entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Dec 2021</entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">Jan 2017 - Feb 2022</entry>
</row>
<row>
<entry>2. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">Jan 2017 - Sep 2021</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2014 - Dec 2021</entry>
</row>
<row>
<entry>3. </entry>
Expand Down
50 changes: 38 additions & 12 deletions modules/dialplan/README
View file
Expand Up @@ -44,7 +44,8 @@ dialplan Module
1.8.2. dp_translate
1.8.3. dp_show_partiton

1.9. Installation
1.9. Provided Status/Report Identifiers
1.10. Installation

2. Developer's Guide
3. Contributors
Expand Down Expand Up @@ -519,7 +520,32 @@ xlog("'$var(in)' matched against partition '$var(part)'\n")
MI DATAGRAM Command Format:
opensips-cli -x mi dp_translate default

1.9. Installation
1.9. Provided Status/Report Identifiers

The module provides the "dialplan" Status/Report group, where
each dialplan partition is defined as a separate SR identifier.

The status of these identifiers reflects the readiness/status
of the cached data (if available or not when being loaded from
DB):
* -2 - no data at all (initial status)
* -1 - no data, initial loading in progress
* 1 - data loaded, partition ready
* 2 - data available, a reload in progress

In terms of reports/logs, the following events will be
reported:
* starting DB data loading
* DB data loading failed, discarding
* DB data loading successfully completed
* N rules loaded (N discarded)

For how to access and use the Status/Report information, please
see
https://www.opensips.org/Documentation/Interface-StatusReport-3
-3.

1.10. Installation

The modules requires one table in OpenSIPS database:
dialplan.The SQL syntax to create them can be found in
Expand All @@ -544,7 +570,7 @@ Chapter 3. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Liviu Chircu (@liviuchircu) 68 44 971 938
2. Bogdan-Andrei Iancu (@bogdan-iancu) 61 41 657 852
2. Bogdan-Andrei Iancu (@bogdan-iancu) 68 44 863 980
3. Ionut Ionita (@ionutrazvanionita) 40 20 1149 579
4. Anca Vamanu 33 5 3263 19
5. Andrei Dragus 24 3 382 1029
Expand Down Expand Up @@ -580,12 +606,12 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Jul 2012 - Nov 2021
2. Maksym Sobolyev (@sobomax) Jan 2021 - Jan 2021
3. Zero King (@l2dy) Mar 2020 - Mar 2020
4. Razvan Crainea (@razvancrainea) Dec 2010 - Sep 2019
5. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
6. Bogdan-Andrei Iancu (@bogdan-iancu) Jun 2008 - Apr 2019
1. Bogdan-Andrei Iancu (@bogdan-iancu) Jun 2008 - Feb 2022
2. Liviu Chircu (@liviuchircu) Jul 2012 - Nov 2021
3. Maksym Sobolyev (@sobomax) Jan 2021 - Jan 2021
4. Zero King (@l2dy) Mar 2020 - Mar 2020
5. Razvan Crainea (@razvancrainea) Dec 2010 - Sep 2019
6. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
7. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018
8. Ovidiu Sas (@ovidiusas) Sep 2008 - Nov 2015
9. Ionut Ionita (@ionutrazvanionita) Jul 2014 - Nov 2015
Expand All @@ -604,9 +630,9 @@ Chapter 4. Documentation

4.1. Contributors

Last edited by: Liviu Chircu (@liviuchircu), Zero King (@l2dy),
Vlad Patrascu (@rvlad-patrascu), Bogdan-Andrei Iancu
(@bogdan-iancu), Razvan Crainea (@razvancrainea), Peter
Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Liviu
Chircu (@liviuchircu), Zero King (@l2dy), Vlad Patrascu
(@rvlad-patrascu), Razvan Crainea (@razvancrainea), Peter
Lemenkov (@lemenkov), Ovidiu Sas (@ovidiusas), Ionut Ionita
(@ionutrazvanionita), Andrei Dragus, Anca Vamanu.

Expand Down
28 changes: 14 additions & 14 deletions modules/dialplan/doc/contributors.xml
View file
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">61</entry>
<entry align="center">41</entry>
<entry align="center">657</entry>
<entry align="center">852</entry>
<entry align="center">68</entry>
<entry align="center">44</entry>
<entry align="center">863</entry>
<entry align="center">980</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -128,34 +128,34 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Jun 2008 - Feb 2022</entry>
</row>
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jul 2012 - Nov 2021</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Jan 2021 - Jan 2021</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>Zero King (<ulink url="https://github.com/l2dy">@l2dy</ulink>)</entry>
<entry align="center">Mar 2020 - Mar 2020</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Dec 2010 - Sep 2019</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Apr 2019</entry>
</row>
<row>
<entry>6. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Jun 2008 - Apr 2019</entry>
</row>
<row>
<entry>7. </entry>
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
Expand Down Expand Up @@ -190,7 +190,7 @@
<title>Documentation</title>
<section id="documentation_contributors" xreflabel="documentation_contributors">
<title>Contributors</title>
<para><emphasis role='bold'>Last edited by:</emphasis> Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Zero King (<ulink url="https://github.com/l2dy">@l2dy</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Andrei Dragus, Anca Vamanu.</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Zero King (<ulink url="https://github.com/l2dy">@l2dy</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Andrei Dragus, Anca Vamanu.</para>
</section>

</chapter>

0 comments on commit 9afb666

Please sign in to comment.