Skip to content

Commit 65d4fda

Browse files
opensips-githubopensips-github
committed
Rebuild documentation
1 parent ed9cff4 commit 65d4fda

144 files changed

Lines changed: 2670 additions & 2185 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎modules/aaa_diameter/README‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ Chapter 2. Contributors
474474
commits^(2) and lines added/removed^(3)
475475
Name DevScore Commits Lines ++ Lines --
476476
1. Liviu Chircu (@liviuchircu) 115 38 6851 1106
477-
2. Razvan Crainea (@razvancrainea) 41 23 1465 272
477+
2. Razvan Crainea (@razvancrainea) 42 24 1466 274
478478
3. Alexandra Titoc 6 4 11 2
479479
4. Peter Lemenkov (@lemenkov) 4 2 2 2
480480
5. Larry Laffer 3 1 6 5
@@ -501,7 +501,7 @@ Chapter 2. Contributors
501501

502502
Table 2.2. Most recently active contributors^(1) to this module
503503
Name Commit Activity
504-
1. Razvan Crainea (@razvancrainea) May 2023 - Jan 2026
504+
1. Razvan Crainea (@razvancrainea) May 2023 - Mar 2026
505505
2. Liviu Chircu (@liviuchircu) May 2021 - Jul 2025
506506
3. Darius Stefan Jul 2025 - Jul 2025
507507
4. Peter Lemenkov (@lemenkov) Jul 2024 - Jul 2025

‎modules/aaa_diameter/doc/contributors.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@
2929
<row>
3030
<entry>2. </entry>
3131
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
32-
<entry align="center">41</entry>
33-
<entry align="center">23</entry>
34-
<entry align="center">1465</entry>
35-
<entry align="center">272</entry>
32+
<entry align="center">42</entry>
33+
<entry align="center">24</entry>
34+
<entry align="center">1466</entry>
35+
<entry align="center">274</entry>
3636
</row>
3737
<row>
3838
<entry>3. </entry>
@@ -105,7 +105,7 @@
105105
<row>
106106
<entry>1. </entry>
107107
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
108-
<entry align="center">May 2023 - Jan 2026</entry>
108+
<entry align="center">May 2023 - Mar 2026</entry>
109109
</row>
110110
<row>
111111
<entry>2. </entry>

‎modules/auth_aka/README‎

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ Auth_aka Module
4848

4949
1.7. Exported MI Functions
5050

51-
1.7.1. aka_av_add
52-
1.7.2. aka_av_drop
53-
1.7.3. aka_av_drop_all
54-
1.7.4. aka_av_fail
51+
1.7.1. auth_aka:av_add
52+
1.7.2. auth_aka:av_drop
53+
1.7.3. auth_aka:av_drop_all
54+
1.7.4. auth_aka:av_fail
5555

5656
2. Contributors
5757

@@ -87,9 +87,9 @@ Auth_aka Module
8787
1.14. aka_av_drop usage
8888
1.15. aka_av_drop_all usage
8989
1.16. aka_av_fail usage
90-
1.17. aka_av_add usage
91-
1.18. aka_av_drop usage
92-
1.19. aka_av_drop_all usage
90+
1.17. auth_aka:av_add usage
91+
1.18. auth_aka:av_drop usage
92+
1.19. auth_aka:av_drop_all usage
9393
1.20. aka_av_drop usage
9494

9595
Chapter 1. Admin Guide
@@ -539,7 +539,9 @@ aka_av_fail("sip:test@siphub.com", "test@siphub.com", 3);
539539

540540
1.7. Exported MI Functions
541541

542-
1.7.1. aka_av_add
542+
1.7.1. auth_aka:av_add
543+
544+
Replaces obsolete MI command: aka_av_add.
543545

544546
Adds an Authentication Vector through the MI interface.
545547

@@ -561,10 +563,10 @@ aka_av_fail("sip:test@siphub.com", "test@siphub.com", 3);
561563
should be used for. If missing, the AV can be used for any
562564
AKA algorithm.
563565

564-
Example 1.17. aka_av_add usage
566+
Example 1.17. auth_aka:av_add usage
565567
...
566568
## adds an AKA AV
567-
$ opensips-cli -x mi aka_av_add \
569+
$ opensips-cli -x mi auth_aka:av_add \
568570
sip:test@siphub.com
569571
test@siphub.com
570572
KFQ/MpR3cE3V9PxucEQS5KED8uUNYIAALFyk59sI
@@ -574,7 +576,9 @@ JI4=
574576
6151667b9ef815c1dcb87473685f062a
575577
...
576578

577-
1.7.2. aka_av_drop
579+
1.7.2. auth_aka:av_drop
580+
581+
Replaces obsolete MI command: aka_av_drop.
578582

579583
Invalidates an Authentication Vector of an user identified by
580584
its authenticate value.
@@ -587,17 +591,19 @@ JI4=
587591
* authenticate (string) - the authenticate/nonce to indentify
588592
the authentication vector.
589593

590-
Example 1.18. aka_av_drop usage
594+
Example 1.18. auth_aka:av_drop usage
591595
...
592596
## adds an AKA AV
593-
$ opensips-cli -x mi aka_av_drop \
597+
$ opensips-cli -x mi auth_aka:av_drop \
594598
sip:test@siphub.com
595599
test@siphub.com
596600
KFQ/MpR3cE3V9PxucEQS5KED8uUNYIAALFyk59sI
597601
JI4=
598602
...
599603

600-
1.7.3. aka_av_drop_all
604+
1.7.3. auth_aka:av_drop_all
605+
606+
Replaces obsolete MI command: aka_av_drop_all.
601607

602608
Invalidates all Authentication Vectors of an user through the
603609
MI interface.
@@ -608,15 +614,17 @@ JI4=
608614
* private_identity (string) - the private identity (IMPI) of
609615
the user to drop authentication vectors for.
610616

611-
Example 1.19. aka_av_drop_all usage
617+
Example 1.19. auth_aka:av_drop_all usage
612618
...
613619
## adds an AKA AV
614-
$ opensips-cli -x mi aka_av_drop_all \
620+
$ opensips-cli -x mi auth_aka:av_drop_all \
615621
sip:test@siphub.com
616622
test@siphub.com
617623
...
618624

619-
1.7.4. aka_av_fail
625+
1.7.4. auth_aka:av_fail
626+
627+
Replaces obsolete MI command: aka_av_fail.
620628

621629
Indicates the fact that the fetching of an authentication
622630
vector has failed, unlocking the processing of the message.
@@ -651,7 +659,7 @@ Chapter 2. Contributors
651659
Table 2.1. Top contributors by DevScore^(1), authored
652660
commits^(2) and lines added/removed^(3)
653661
Name DevScore Commits Lines ++ Lines --
654-
1. Razvan Crainea (@razvancrainea) 54 20 3378 295
662+
1. Razvan Crainea (@razvancrainea) 58 23 3420 317
655663
2. Alexandra Titoc 4 2 2 2
656664
3. LarryLaffer-dev 3 1 26 1
657665
4. Liviu Chircu (@liviuchircu) 3 1 1 1
@@ -676,7 +684,7 @@ Chapter 2. Contributors
676684

677685
Table 2.2. Most recently active contributors^(1) to this module
678686
Name Commit Activity
679-
1. Razvan Crainea (@razvancrainea) Feb 2024 - Jul 2025
687+
1. Razvan Crainea (@razvancrainea) Feb 2024 - Mar 2026
680688
2. LarryLaffer-dev Mar 2025 - Mar 2025
681689
3. Liviu Chircu (@liviuchircu) Sep 2024 - Sep 2024
682690
4. Alexandra Titoc Sep 2024 - Sep 2024

‎modules/auth_aka/doc/contributors.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@
2121
<row>
2222
<entry>1. </entry>
2323
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
24-
<entry align="center">54</entry>
25-
<entry align="center">20</entry>
26-
<entry align="center">3378</entry>
27-
<entry align="center">295</entry>
24+
<entry align="center">58</entry>
25+
<entry align="center">23</entry>
26+
<entry align="center">3420</entry>
27+
<entry align="center">317</entry>
2828
</row>
2929
<row>
3030
<entry>2. </entry>
@@ -81,7 +81,7 @@
8181
<row>
8282
<entry>1. </entry>
8383
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
84-
<entry align="center">Feb 2024 - Jul 2025</entry>
84+
<entry align="center">Feb 2024 - Mar 2026</entry>
8585
</row>
8686
<row>
8787
<entry>2. </entry>

‎modules/b2b_entities/README‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ B2B_ENTITIES
4444

4545
1.5. Exported MI Functions
4646

47-
1.5.1. b2be_list
47+
1.5.1. b2b_entities:list
4848
1.5.2. ua_session_client_start
4949
1.5.3. ua_session_update
5050
1.5.4. ua_session_reply
@@ -467,17 +467,19 @@ ua_session_terminate($var(b2b_key));
467467

468468
1.5. Exported MI Functions
469469

470-
1.5.1. b2be_list
470+
1.5.1. b2b_entities:list
471+
472+
Replaces obsolete MI command: b2be_list.
471473

472474
This command can be used to list the internals of the b2b
473475
entities.
474476

475-
Name: b2be_list
477+
Name: b2b_entities:list
476478

477479
Parameters: none
478480

479481
MI FIFO Command Format:
480-
opensips-cli -x mi b2be_list
482+
opensips-cli -x mi b2b_entities:list
481483

482484
1.5.2. ua_session_client_start
483485

@@ -814,7 +816,7 @@ Chapter 3. Contributors
814816
Name DevScore Commits Lines ++ Lines --
815817
1. Anca Vamanu 183 94 6839 1860
816818
2. Vlad Patrascu (@rvlad-patrascu) 127 62 5443 1147
817-
3. Razvan Crainea (@razvancrainea) 93 76 841 539
819+
3. Razvan Crainea (@razvancrainea) 97 79 857 551
818820
4. Bogdan-Andrei Iancu (@bogdan-iancu) 62 53 525 209
819821
5. Ovidiu Sas (@ovidiusas) 58 43 988 348
820822
6. Liviu Chircu (@liviuchircu) 22 18 99 128

‎modules/b2b_entities/doc/contributors.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@
3737
<row>
3838
<entry>3. </entry>
3939
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
40-
<entry align="center">93</entry>
41-
<entry align="center">76</entry>
42-
<entry align="center">841</entry>
43-
<entry align="center">539</entry>
40+
<entry align="center">97</entry>
41+
<entry align="center">79</entry>
42+
<entry align="center">857</entry>
43+
<entry align="center">551</entry>
4444
</row>
4545
<row>
4646
<entry>4. </entry>

‎modules/b2b_logic/README‎

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ B2B_LOGIC
6969

7070
1.6. Exported MI Functions
7171

72-
1.6.1. b2b_trigger_scenario
73-
1.6.2. b2b_bridge
74-
1.6.3. b2b_list
75-
1.6.4. b2b_terminate_call
72+
1.6.1. b2b_logic:trigger_scenario
73+
1.6.2. b2b_logic:bridge
74+
1.6.3. b2b_logic:list
75+
1.6.4. b2b_logic:terminate_call
7676

7777
1.7. Exported Pseudo-Variables
7878

@@ -923,15 +923,17 @@ vp(header), $avp(header_content), "callee,sip:user@10.0.0.1,sip:10.0.0.1
923923

924924
1.6. Exported MI Functions
925925

926-
1.6.1. b2b_trigger_scenario
926+
1.6.1. b2b_logic:trigger_scenario
927+
928+
Replaces obsolete MI command: b2b_trigger_scenario.
927929

928930
This command initializes a new B2B session where OpenSIPS will
929931
start a call from the middle. The initial entities to be
930932
connected are specified through the command's parameters and
931933
further scenario logic can be implemented in the b2b_logic
932934
dedicated routes.
933935

934-
Name: b2b_trigger_scenario
936+
Name: b2b_logic:trigger_scenario
935937

936938
Parameters:
937939
* senario_id : ID for the scenario of this B2B session.
@@ -948,19 +950,21 @@ vp(header), $avp(header_content), "callee,sip:user@10.0.0.1,sip:10.0.0.1
948950
the format: key=value
949951

950952
MI FIFO Command Format:
951-
opensips-cli -x mi b2b_trigger_scenario marketing client1,sip:bo
952-
b@opensips.org client2,sip:322@opensips.org:5070 agent_uri=sip:alice@ope
953-
nsips.org
953+
opensips-cli -x mi b2b_logic:trigger_scenario marketing client1,
954+
sip:bob@opensips.org client2,sip:322@opensips.org:5070 agent_uri=sip:ali
955+
ce@opensips.org
956+
957+
1.6.2. b2b_logic:bridge
954958

955-
1.6.2. b2b_bridge
959+
Replaces obsolete MI command: b2b_bridge.
956960

957961
This command can be used by an external application to tell
958962
B2BUA to bridge a call party from an on going dialog to another
959963
destination. By default the caller is bridged to the new uri
960964
and BYE is set to the callee. You can instead bridge the callee
961965
if you send 1 as the third parameter.
962966

963-
Name: b2b_bridge
967+
Name: b2b_logic:bridge
964968

965969
Parameters:
966970
* dialog_id : the b2b_logic key, or the
@@ -979,35 +983,41 @@ nsips.org
979983
bridging scenario
980984

981985
MI FIFO Command Format:
982-
opensips-cli -x mi b2b_bridge 1020.30 sip:alice@opensips.org
986+
opensips-cli -x mi b2b_logic:bridge 1020.30 sip:alice@opensips.o
987+
rg
983988

984989
opensips-cli Command Format:
985-
opensips-cli -x mi b2b_bridge 1020.30 sip:alice@opensips.org
990+
opensips-cli -x mi b2b_logic:bridge 1020.30 sip:alice@opensips.o
991+
rg
986992

987-
1.6.3. b2b_list
993+
1.6.3. b2b_logic:list
994+
995+
Replaces obsolete MI command: b2b_list.
988996

989997
This command can be used to list the internals of b2b_logic
990998
entities.
991999

992-
Name: b2b_list
1000+
Name: b2b_logic:list
9931001

9941002
Parameters: none
9951003

9961004
MI FIFO Command Format:
997-
opensips-cli -x mi b2b_list
1005+
opensips-cli -x mi b2b_logic:list
1006+
1007+
1.6.4. b2b_logic:terminate_call
9981008

999-
1.6.4. b2b_terminate_call
1009+
Replaces obsolete MI command: b2b_terminate_call.
10001010

10011011
Terminates an ongoing B2B session.
10021012

1003-
Name: b2b_terminate_call
1013+
Name: b2b_logic:terminate_call
10041014

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

10091019
MI FIFO Command Format:
1010-
opensips-cli -x mi b2b_terminate_call 159.0
1020+
opensips-cli -x mi b2b_logic:terminate_call 159.0
10111021

10121022
1.7. Exported Pseudo-Variables
10131023

@@ -1298,7 +1308,7 @@ Chapter 3. Contributors
12981308
commits^(2) and lines added/removed^(3)
12991309
Name DevScore Commits Lines ++ Lines --
13001310
1. Vlad Patrascu (@rvlad-patrascu) 239 57 8167 6793
1301-
2. Razvan Crainea (@razvancrainea) 51 33 1427 337
1311+
2. Razvan Crainea (@razvancrainea) 55 36 1468 362
13021312
3. Bogdan-Andrei Iancu (@bogdan-iancu) 15 11 152 76
13031313
4. Nick Altmann (@nikbyte) 14 10 346 36
13041314
5. Carsten Bock 12 5 679 23
@@ -1332,7 +1342,7 @@ Chapter 3. Contributors
13321342

13331343
Table 3.2. Most recently active contributors^(1) to this module
13341344
Name Commit Activity
1335-
1. Razvan Crainea (@razvancrainea) Jan 2021 - Dec 2025
1345+
1. Razvan Crainea (@razvancrainea) Jan 2021 - Mar 2026
13361346
2. Ovidiu Sas (@ovidiusas) Dec 2025 - Dec 2025
13371347
3. dirkbro Dec 2025 - Dec 2025
13381348
4. andingv Nov 2025 - Nov 2025

0 commit comments

Comments
 (0)