Skip to content

Commit

Permalink
Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
opensips-github committed Jan 7, 2023
1 parent 211a63c commit 8c613f8
Show file tree
Hide file tree
Showing 8 changed files with 58 additions and 31 deletions.
4 changes: 2 additions & 2 deletions modules/acc/README
Expand Up @@ -1059,7 +1059,7 @@ Chapter 3. Contributors
2. Jan Janak (@janakj) 145 16 5587 5074
3. Ionut Ionita (@ionutrazvanionita) 139 39 3730 4180
4. Razvan Crainea (@razvancrainea) 98 65 2702 662
5. Liviu Chircu (@liviuchircu) 63 49 604 549
5. Liviu Chircu (@liviuchircu) 65 50 614 558
6. Jiri Kuthan (@jiriatipteldotorg) 56 26 2272 660
7. Daniel-Constantin Mierla (@miconda) 26 23 115 88
8. Elena-Ramona Modroiu 24 4 2267 5
Expand Down Expand Up @@ -1096,7 +1096,7 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Jan 2013 - Jul 2022
1. Liviu Chircu (@liviuchircu) Jan 2013 - Jan 2023
2. Alexey Vasilyev (@vasilevalex) Mar 2022 - Mar 2022
3. Razvan Crainea (@razvancrainea) Aug 2010 - Jun 2021
4. Walter Doekes (@wdoekes) Apr 2021 - Apr 2021
Expand Down
10 changes: 5 additions & 5 deletions modules/acc/doc/contributors.xml
Expand Up @@ -53,10 +53,10 @@
<row>
<entry>5. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">63</entry>
<entry align="center">49</entry>
<entry align="center">604</entry>
<entry align="center">549</entry>
<entry align="center">65</entry>
<entry align="center">50</entry>
<entry align="center">614</entry>
<entry align="center">558</entry>
</row>
<row>
<entry>6. </entry>
Expand Down Expand Up @@ -129,7 +129,7 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Jul 2022</entry>
<entry align="center">Jan 2013 - Jan 2023</entry>
</row>
<row>
<entry>2. </entry>
Expand Down
4 changes: 2 additions & 2 deletions modules/dialog/README
Expand Up @@ -2518,7 +2518,7 @@ Chapter 4. Contributors
2. Razvan Crainea (@razvancrainea) 263 197 4974 1497
3. Vlad Paiu (@vladpaiu) 253 144 7205 3026
4. Vlad Patrascu (@rvlad-patrascu) 185 99 3831 3269
5. Liviu Chircu (@liviuchircu) 168 123 2903 1242
5. Liviu Chircu (@liviuchircu) 169 124 2920 1255
6. Ovidiu Sas (@ovidiusas) 32 25 494 120
7. Dan Pascu (@danpascu) 30 25 233 179
8. Eseanu Marius Cristian (@eseanucristian) 18 6 722 341
Expand Down Expand Up @@ -2559,7 +2559,7 @@ Chapter 4. Contributors

Table 4.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Aug 2012 - Nov 2022
1. Liviu Chircu (@liviuchircu) Aug 2012 - Jan 2023
2. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2006 - Nov 2022
3. Razvan Crainea (@razvancrainea) Aug 2010 - Oct 2022
4. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Jul 2022
Expand Down
10 changes: 5 additions & 5 deletions modules/dialog/doc/contributors.xml
Expand Up @@ -53,10 +53,10 @@
<row>
<entry>5. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">168</entry>
<entry align="center">123</entry>
<entry align="center">2903</entry>
<entry align="center">1242</entry>
<entry align="center">169</entry>
<entry align="center">124</entry>
<entry align="center">2920</entry>
<entry align="center">1255</entry>
</row>
<row>
<entry>6. </entry>
Expand Down Expand Up @@ -129,7 +129,7 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Aug 2012 - Nov 2022</entry>
<entry align="center">Aug 2012 - Jan 2023</entry>
</row>
<row>
<entry>2. </entry>
Expand Down
4 changes: 2 additions & 2 deletions modules/msrp_gateway/README
Expand Up @@ -262,7 +262,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 Patrascu (@rvlad-patrascu) 19 8 1217 17
1. Vlad Patrascu (@rvlad-patrascu) 20 9 1219 19

(1) DevScore = author_commits + author_lines_added /
(project_lines_added / project_commits) + author_lines_deleted
Expand All @@ -284,7 +284,7 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Patrascu (@rvlad-patrascu) May 2022 - Jun 2022
1. Vlad Patrascu (@rvlad-patrascu) May 2022 - Jan 2023

(1) including any documentation-related commits, excluding
merge commits
Expand Down
8 changes: 4 additions & 4 deletions modules/msrp_gateway/doc/contributors.xml
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">20</entry>
<entry align="center">9</entry>
<entry align="center">1219</entry>
<entry align="center">19</entry>
<entry align="center">8</entry>
<entry align="center">1217</entry>
<entry align="center">17</entry>
</row>
</tbody>
</tgroup>
Expand Down Expand Up @@ -57,7 +57,7 @@
<row>
<entry>1. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2022 - Jun 2022</entry>
<entry align="center">May 2022 - Jan 2023</entry>
</row>
</tbody>
</tgroup>
Expand Down
39 changes: 33 additions & 6 deletions modules/msrp_ua/README
Expand Up @@ -36,6 +36,7 @@ MSRP UA Module
1.6.1. E_MSRP_SESSION_NEW
1.6.2. E_MSRP_SESSION_END
1.6.3. E_MSRP_MSG_RECEIVED
1.6.4. E_MSRP_REPORT_RECEIVED

2. Contributors

Expand Down Expand Up @@ -217,12 +218,24 @@ if (!has_totag() && is_method("INVITE")) {
message. If missing, an empty message will be sent.
* body (string, optional) - actual message body. If missing,
an empty message will be sent.
* success_report (string, optional) - string indicating
whether to request an MSRP Success Report. Possible values
are yes or no. If the parameter is missing or is set to
"no" the SEND request will not include a Success-Report
header.
* failure_report (string, optional) - string indicating
whether to request an MSRP Failure Report. Possible values
are yes, no or partial, as specified in MSRP. If the
parameter is missing or is set to "yes" the SEND request
will not include a Failure-Report header. Note that if the
header field is not present, the receving MSRP endpoint
must treat it the same as a Failure-Report header with a
value of "yes".

MI FIFO Command Format:
opensips-cli -x mi msrp_ua_send_message \
5addd9e7b74fa44fbace68a4fc562293 \
text/plain \
Hello
session_id=5addd9e7b74fa44fbace68a4fc562293 \
mime=text/plain body=Hello success_report=yes

1.5.2. msrp_ua_start_session

Expand Down Expand Up @@ -302,22 +315,36 @@ opensips-cli -x mi msrp_ua_end_session \
1.6.3. E_MSRP_MSG_RECEIVED

This event is triggered when receiving a new, non-empty MSRP
message from the peer.
SEND request from the peer.

Parameters:
* session_id - The MSRP session identifier ("session-id" part
of the MSRP URI).
* content_type - The content type of this message.
* body - The actual message body.

1.6.4. E_MSRP_REPORT_RECEIVED

This event is triggered when:
* a MSRP REPORT request is received
* a failure transaction response is received
* a local timeout for a SEND request occured.

Parameters:
* session_id - The MSRP session identifier ("session-id" part
of the MSRP URI).
* message_id - The value of the Message-ID header field.
* status - The value of the Status header field.
* byte_range - The value of the Byte-Range header field.

Chapter 2. Contributors

2.1. By Commit Statistics

Table 2.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Vlad Patrascu (@rvlad-patrascu) 43 11 3395 233
1. Vlad Patrascu (@rvlad-patrascu) 48 12 3758 284
2. Razvan Crainea (@razvancrainea) 3 1 11 1
3. Liviu Chircu (@liviuchircu) 3 1 8 8
4. Bogdan-Andrei Iancu (@bogdan-iancu) 3 1 1 1
Expand All @@ -342,7 +369,7 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Vlad Patrascu (@rvlad-patrascu) May 2022 - Oct 2022
1. Vlad Patrascu (@rvlad-patrascu) May 2022 - Jan 2023
2. Razvan Crainea (@razvancrainea) Aug 2022 - Aug 2022
3. Liviu Chircu (@liviuchircu) Jul 2022 - Jul 2022
4. Bogdan-Andrei Iancu (@bogdan-iancu) May 2022 - May 2022
Expand Down
10 changes: 5 additions & 5 deletions modules/msrp_ua/doc/contributors.xml
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">43</entry>
<entry align="center">11</entry>
<entry align="center">3395</entry>
<entry align="center">233</entry>
<entry align="center">48</entry>
<entry align="center">12</entry>
<entry align="center">3758</entry>
<entry align="center">284</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -81,7 +81,7 @@
<row>
<entry>1. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2022 - Oct 2022</entry>
<entry align="center">May 2022 - Jan 2023</entry>
</row>
<row>
<entry>2. </entry>
Expand Down

0 comments on commit 8c613f8

Please sign in to comment.