Repository navigation
ISSUE-234 - Fix API schema inconsistences for r3.2 - #244
Merged
Merged
Conversation
stroncoso
requested review from
deepakjaiswal1,
pradeepachar-mavenir and
teikuran
as code owners
October 16, 2026 09:53
Contributor
Author
|
Hi team, This PR maybe is a little long, but I was trying to cleanup all the inconsistencies noted by Herbert on the review. Then changes make sense to me, and the breaking changes are not really relevant for the functionality of the API, to be honest... Please, take a look and approve ASAP. Thanks |
teikuran
approved these changes
Oct 16, 2026
Contributor
Author
|
Clarification required from commonalites:
|
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:
Fixes the remaining schema and example inconsistencies from #234 , the error-response items were covered already by #241:
MediaSessionCreateno longer inheritsstatus/answerPUTrequest examples now matchMediaSessionStatusChange.Subscription.typesallows 3 items, as the request doespostNotification)subscriptionIdis required inMediaSessionandRegistrationEndsMediaSessionaddress pattern now matchesAddressin call-handlinginitialEventandsubscriptionMaxEvents(and the now-unreachableMAX_EVENTS_REACHED).PUT /subscriptions/{subscriptionId}, which is not part of the Commonalities subscription model.Which issue(s) this PR fixes:
Fixes #234
Special notes for reviewers:
Breaking changes (to be listed in the r3.2 release notes) @teikuran @deepakjaiswal1 :
subscriptionIdrequired in event data (MediaSession,RegistrationEnds): implementations must always send it insession-invitation,session-statusandregistration-endsevents, as required by the Event Subscription Guide for resource-based subscriptions. Consumers can rely on it to correlate events with subscriptions.initialEventandsubscriptionMaxEventsremoved fromConfig: they were documented as not used. Requests that still send them are no longer described by the schema.MAX_EVENTS_REACHEDis removed fromTerminationReasonbecause no subscription can reach a max-events limit anymore.PUT /subscriptions/{subscriptionId}removed, together with thewebrtc-events-subscriptions:updatescope: up to r4.4, the Commonalities subscription model has no update operation. To change the sink credential or expiry, consumers delete the subscription and create a new one.Non-breaking, worth checking:
postNotification) does not change what is sent on the wire. Only the code consumers generate for their callback receiver changes.MediaSessionCreateno longer documentsstatus/answer. The response schema is unchanged. Extra properties are still allowed (additionalPropertiesis notfalse), so the schema doesn't reject them and no negative test is added.MediaSessionaddress pattern now accepts the same formats asAddressin call-handling (urn:service:sos,phone-context,user=phone, anonymous).Subscription.typesaccepts up to 3 items, matching the request. Both only widen what is accepted.Changelog input
Additional documentation
n/a