Repository navigation
ISSUE-221 - Documentation review - #237
Merged
Merged
Conversation
- Inline documentation examples and definitions - READMEs and links review - Supporting docs disclaimers
stroncoso
requested review from
deepakjaiswal1,
pradeepachar-mavenir and
teikuran
as code owners
October 10, 2026 07:19
teikuran
approved these changes
Oct 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
Inline docs contradicted schemas, READMEs had broken links. Fix per review comments (@hdamker, @rartych).
POST /sessionsexample with requiredoffer; drop "add media later" text; pick-up example usesConnected+answer; paths relative to API root.registrationExpireTime(cap/range/min), elseTTL_cfg. Min/max clarified as durations relative to request receipt time. Duplicate RFC 3339 line removed.deviceId;registration-endsno longer invalidates subscription (matches registration API); fix/sessions/{mediaSessionId}path.CAMARA:MANDATORY:*:BEGINmarkers (Swagger-UI rendering, matches Commonalities template).code/API_definitions/README.MD(root README links YAMLs per release); drop brokenAPI_documentationlinks; simplify Test_definitions README; update SupportingDocuments index and MeetingMinutes wiki link; stale-doc disclaimer onwebrtc voice api.md.Which issue(s) this PR fixes:
Fixes #221
Special notes for reviewers:
webrtc-call-handling.yamlPOST action (create new call) does not support late SDP offer. Current YAML request a mandatoryoffer. The example was updated according to that.Changelog input
Additional documentation
n/a