Review and improve documentation #221

Activity

1. rartych

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   on Sep 9, 2026
2. rartych

   added a parent issue on Sep 9, 2026

   • Release r3.1 review findings #213
3. stroncoso

   added the

   Task

   issue type on Sep 21, 2026
4. stroncoso

   self-assigned this

   on Sep 21, 2026
5. hdamker commented on Sep 27, 2026

   

   hdamker

   on Sep 27, 2026

   Contributor

   More actions

   In addition to the README points, the inline documentation contradicts the schemas in several places:

   • webrtc-call-handling:
     • The first POST /sessions example omits the required offer, isn't valid JSON, and uses /v0.2 paths (L90-L99).
     • The text says media can be added later.
     • The "picking up" example uses InProgress with an answer, while the operation description uses Connected.
   • webrtc-registration: the PUT refresh algorithm always sets newExpire = t_req + TTL_cfg (L364-L372), while registrationExpireTime says a requested value within range "is applied as-is" (L584-L594).
   • webrtc-events-subscriptions:
     • One description says the subscription is no longer valid after a registration ends (L1780-L1785); webrtc-registration says event subscriptions "are not affected" (L86-L88).
     • Several descriptions and examples still refer to per-session or per-registration subscriptions, although subscriptions are now per deviceId.
     • The text says "two types of events" but lists three.

   👍React with 👍1Reacted by Santiago Troncoso
6. stroncoso commented on Sep 27, 2026

   

   stroncoso

   on Sep 27, 2026

   Contributor

   More actions

   Thanks for the review, I'll add an issue to cover the defects detected.

   BR,
7. deepakjaiswal1

   closed this as completedin #237on Oct 11, 2026