Releases: camaraproject/WebRTC
r2.2
Release Notes
This public release contains the definition and documentation of
- webrtc-registration v0.3.0
- webrtc-call-handling v0.3.0
- webrtc-events v0.2.0
The API definition(s) are based on
- Commonalities r3.3
- Identity and Consent Management r3.3
Changelog since latest public v1.2
- Full Changelog with the list of PRs and contributors: r1.2...r2.2
webrtc-registration v0.3.0
- API definition with inline documentation:
Added
- Support registration expiry updates and termination event notifications at PR #83
- Introduced
regSessionUpdateschema with optionalregistrationExpireTimefield to allow clients to request a new expiry time. - Added 200 OK response definition for
PUT /sessions/{registrationId}to acknowledge successful updates.
Changed
- fix: Updated deviceId format, examples and tests at #91
- fix: registrationId became mandatory on registration response at #93
- Commonalities aligment 0.6 at PR #90
- fix: Remove AUTHENTICATION_REQUIRED error code
- doc: Update
types(multiple) property ofSubscriptionschema - feat: Error 422 MULTIEVENT_COMBINATION_TEMPORARILY_NOT_SUPPORTED added
- fix: Remove IDENTIFIER_MISMATCH error
- fix: x-correlator format update, along test and schema update
- Extended
regSessionResponseschema to includeexpiresAt, indicating the assigned expiry time of the registration session at PR #83 - fix: Description for date-time review at #101
- fix: ErrorInfo updated descriptions at #113
webrtc-call-handling v0.3.0
- API definition with inline documentation:
Changes
- fix: Added 400 error response at #91
- Commonalities aligment 0.6 at PR #90
- fix: Remove AUTHENTICATION_REQUIRED error code
- doc: Update
types(multiple) property ofSubscriptionschema - feat: Error 422 MULTIEVENT_COMBINATION_TEMPORARILY_NOT_SUPPORTED added
- fix: Remove IDENTIFIER_MISMATCH error
- fix: x-correlator format update, along test and schema update
- fix: Removed too wide insecure pattern .+ from address fields at #103
- fix: ErrorInfo updated descriptions at #113
webrtc-events v0.2.0
- API definition with inline documentation:
Added
- Added new event type
webrtc-events:org.camaraproject.webrtc-events.v0.registration-endsto notify subscribers when a registration ends at PR #83 - Provided a concrete example for the
registration-endsevent subscription.
Changes
- fix: Updated deviceId format, examples and tests at #91
- fix: Updated mandatory fields per specific event data callback at #94
- Commonalities aligment 0.6 at PR #90
- fix: Remove AUTHENTICATION_REQUIRED error code
- doc: Update
types(multiple) property ofSubscriptionschema - feat: Error 422 MULTIEVENT_COMBINATION_TEMPORARILY_NOT_SUPPORTED added
- fix: Remove IDENTIFIER_MISMATCH error
- fix: x-correlator format update, along test and schema update
- Extended
TerminationReasonenumeration to includeREGISTRATION_EXPIRED, allowing precise classification of expiry-based terminations at PR #83 - fix: Description for date-time review at #101
- fix: Updated mandatory fields for EventSessionInvitation at #102
- fix: Removed too wide insecure pattern .+ from address fields #103
- fix: ErrorInfo updated descriptions at #113
r2.1
Release Notes
This pre-release contains the definition and documentation of
- webrtc-registration v0.3.0-rc.1
- webrtc-call-handling v0.3.0-rc.1
- webrtc-events v0.2.0-rc.1
The API definition(s) are based on
- Commonalities r3.2
- Identity and Consent Management r3.2
Changelog since latest public r1.2
- Full Changelog with the list of PRs and contributors: r1.2...r2.1
WebRTC Registration v0.3.0-rc.1
- API definition with inline documentation:
Added
- Support registration expiry updates and termination event notifications at PR #83
- Introduced
regSessionUpdateschema with optionalregistrationExpireTimefield to allow clients to request a new expiry time. - Added 200 OK response definition for
PUT /sessions/{registrationId}to acknowledge successful updates.
Changed
- fix: Updated deviceId format, examples and tests at #91
- fix: registrationId became mandatory on registration response at #93
- Commonalities aligment 0.6 at PR #88
- fix: Remove AUTHENTICATION_REQUIRED error code
- doc: Update
types(multiple) property ofSubscriptionschema - feat: Error 422 MULTIEVENT_COMBINATION_TEMPORARILY_NOT_SUPPORTED added
- fix: Remove IDENTIFIER_MISMATCH error
- fix: x-correlator format update, along test and schema update
- Extended
regSessionResponseschema to includeexpiresAt, indicating the assigned expiry time of the registration session at PR #83
webrtc-call-handling v0.3.0-rc.1
- API definition with inline documentation:
Changes
- fix: Added 400 error response at #91
- Commonalities aligment 0.6 at PR #88
- fix: Remove AUTHENTICATION_REQUIRED error code
- doc: Update
types(multiple) property ofSubscriptionschema - feat: Error 422 MULTIEVENT_COMBINATION_TEMPORARILY_NOT_SUPPORTED added
- fix: Remove IDENTIFIER_MISMATCH error
- fix: x-correlator format update, along test and schema update
WebRTC Events v0.2.0-rc.1
- API definition with inline documentation:
Added
- Added new event type
webrtc-events:org.camaraproject.webrtc-events.v0.registration-endsto notify subscribers when a registration ends at PR #83 - Provided a concrete example for the
registration-endsevent subscription.
Changes
- fix: Updated deviceId format, examples and tests at #91
- fix: Updated mandatory fields per specific event data callback at #94
- Commonalities aligment 0.6 at PR #88
- fix: Remove AUTHENTICATION_REQUIRED error code
- doc: Update
types(multiple) property ofSubscriptionschema - feat: Error 422 MULTIEVENT_COMBINATION_TEMPORARILY_NOT_SUPPORTED added
- fix: Remove IDENTIFIER_MISMATCH error
- fix: x-correlator format update, along test and schema update
- Extended
TerminationReasonenumeration to includeREGISTRATION_EXPIRED, allowing precise classification of expiry-based terminations at PR #83
r1.2
WebRTC APIs - Release r1.2
Release Notes
This public release contains the definition and documentation of
- webrtc-registration v0.2.0
- webrtc-call-handling v0.2.0
- webrtc-events v0.1.0
The API definition(s) are based on
- Commonalities r2.3
- Identity and Consent Management r2.3
Repository changelog since latest public v0.1.1
- Full Changelog with the list of PRs and contributors: v0.1.1...r1.2
List of PRs and their owners
- Update BYON-Notification-Channel.yaml by @pradeepachar-mavenir in #48
- Update CODEOWNERS by @TEF-RicardoSerr in #49
- Fall 24 Documentation by @TEF-RicardoSerr in #47
- Doc/repo nav pages by @stroncoso-quobis in #46
- Notification compliance by @stroncoso-quobis in #53
- feat(callhandling): VvoipSessionInformation schema reviewed by @stroncoso-quobis in #56
- Fix/api file names by @stroncoso-quobis in #59
- Commonalities alignment for webrtc-events.yaml by @rartych in #66
- Commonalities 0.5 aligment by @stroncoso-quobis in #65
- Registration API - Inline documentation expanded by @stroncoso-quobis in #67
- Call handling API - Inline documentation expanded by @stroncoso-quobis in #68
- doc: Included base testing scenarios by @stroncoso-quobis in #69
- WebRTC r1.1 - Release candidate preparations by @stroncoso-quobis in #62
- Fix/release m4 review by @stroncoso-quobis in #71
WebRTC Registration v0.2.0
There are breaking changes compared to v0.1.2.: the API use has been simplified for API consumers using a three-legged access token to invoke the API. In these cases the optional device parameter MUST NOT be provided, as the subject will be uniquely identified from the access token. In this context also some error response codes have been renamed or replaced to comply with latests Commonalities.
- API definition with inline documentation:
Added
- YAML inline documentation at PR #67
- Commonalites aligment 0.5 at PR #65
- Included base testing scenarios at PR #69
- Included basic error testing at PR #71
Changed
- API naming to WebRTC Registarion and filename
webrtc-registration.yamlPR #59 - Server
urlbased on Commonalities 0.5 at PR #59 - Security schema
openIdbased on Commonalities 0.5 at PR #65 - Response code based on Commonalities 0.5 at PR #65
- Term
RACMis replaced byRegistrationorregsuffix - TransactionId header (required) was replaced by x-correlator header (optional)
msisdnresponse is nowphoneNumberracmSessionIdbecomes nowregsitrationId
Fixed
- Descriptions and relevant information for all documentation and schemas
- Descriptions updates and references
- Commonalities alignment with r2.3 (Responses and documentation)
- Responses review : 400, 401, 403 included
- PUT registration responds with 204 No content instead of 200
Removed
BYONterminology and API namingnotificationChannelAPI related parameterchannelIdat PR #67BearerAuthin favor ofopenIdas security schema at PR #65- Removed generic 5xx reponses
clientIdheader is removed
WebRTC Call Handling v0.2.0
There are breaking changes compared to v0.1.2.: the API use has been simplified for API consumers using a three-legged access token to invoke the API. In these cases the optional device parameter MUST NOT be provided, as the subject will be uniquely identified from the access token. In this context also some error response codes have been renamed or replaced to comply with Commonalities 0.5.
- API definition with inline documentation:
Added
- YAML inline documentation at PR #68
- Commonalites aligment 0.5 at PR #65
- Included base testing scenarios at PR #69
- Included basic error testing
Changed
- API naming to WebRTC Call Handling and filename
webrtc-call-handling.yamlPR #59 - Server
urlbased on Commonalities 0.5 at PR #59 - Security schema
openIdbased on Commonalities 0.5 at PR #65 - Response code based on Commonalities 0.5 at PR #65
MediaSessionInformationschema expanded, to include all fields used related to a single voice-video session at PR #56SessionNotificationschema updated at PR #56- It aligns this API with the WebRTC Event notification service. So
SessionNotificationschema, now, its just a wrapper forMediaSessionInformationschema. This way, the developer only need to use one object for notification and voice-video session updates (POST / PUT operations).
- It aligns this API with the WebRTC Event notification service. So
- Term
RACMis replaced byRegistrationorregsuffix - Suffix
vvoipis replaced bymediato identify media sessions, like calls, video-calls or any media session - TransactionId header (required) was replaced by x-correlator header (optional)
Fixed
- Descriptions and relevant information for all documentation and schemas
- Descriptions updates and references
- Commonalities alignment with r2.3 (Responses and documentation)
- Responses review : 400, 401, 403 included
Removed
BYONterminology and API namingBearerAuthin favor ofopenIdas security schema at PR #65SessionNotificationschema updated at PR #56SessionInvitationNotification- Became part ofSessionNotificationSessionStatusNotification- Became part ofSessionNotification
- Removed generic 5xx reponses
clientIdheader is removed
WebRTC Events v0.1.0
This version defines a new API:
Initial version covering the following functionality and related endpoints:
- API to subscribe to call events. Bringing server-side updates about a voice video session in progress or during negotiation.
- API definition with inline documentation:
Added
- YAML inline documentation at PR #53
- Commonalites aligment 0.5 at PR #66
- Included
subscriptionsendpoint to create CloudEvents subscrition at PR #53- Endpoints can now define a callback and receive server-side events using CloudEvents
- Endpoints can now receive callback events regarding new available audio-video sessions (call incomming)
- Endpoints can now receive callback events regarding session establishment updates like network changes and remote session termination (call progress and call hangup)
- Included base testing scenarios at PR #69
- Included basic error testing
Changed
- Term
RACMis replaced byRegistrationorregsuffix - Suffix
vvoipis replaced bymediato identify media sessions, like calls, video-calls or any media session
Fixed
- Commonalities alignment with r2.3 (Responses and documentation)
r1.1
WebRTC APIs - Release 0.1.1
This release includes:
- webrtc-registration v0.2
- webrtc-call-handling v0.2
- webrtc-events v0.1
Documentation
Please note
This is a pre-release version, and should be considered as a draft for further development
There are bug fixes and breaking changes to be expected in later versions
The release is suitable for test implementations, but it is not recommended for use in production environments
Added
- webrtc-events API: To handle server-side communications based on CloudEvents at PR #53
- Included
subscriptionsendpoint to create CloudEvents subscrition - Device endpoints can now define a callback and receive server-side events using CloudEvents
- Device endpoints can now receive callback events regarding new available audio-video sessions (call incomming)
- Device endpoints can now receive callback events regarding session establishment updates like network changes and remote session termination (call progress and call hangup)
- Included
- Included base testing scenarios for all APIs at PR #69
- Inline documentation extended #67 #68
- YAML inline documentation at PR #67
- Commonalites aligment 0.5 at PR #65 #66
Changed
- Renamed APIs to be more meaningful and according CAMARA API naming rules
- Server
urlbased on Commonalities 0.5 at PR #59 - Security schema
openIdbased on Commonalities 0.5 at PR #65 #66 - Response code based on Commonalities 0.5 at PR #65
SessionNotificationschema updated at PR #56- It aligns this API with the WebRTC Event notification service. So
SessionNotificationschema, now, its just a wrapper forVvoipSessionInformationschema. This way, the developer only need to use one object for notification and voice-video session updates (POST / PUT operations).
- It aligns this API with the WebRTC Event notification service. So
Fixed
- Descriptions and relevant information for all documentation and schemas
Removed
- notification-channel API removed.
- Its functionlity is removed from scope, CAMARA API includes CloudEvents as main source of incoming connections from the network. This API is removed in benefit of
webrtc-events.webrtc-call-handling(call establishment) andwebrtc-register(incoming call reception) can benefit fromwebrtc-eventsAPI along with other possible use cases regarding vislibility.
- Its functionlity is removed from scope, CAMARA API includes CloudEvents as main source of incoming connections from the network. This API is removed in benefit of
channelIdparameter removed #67 #68BYONterminology and API namingBearerAuthin favor ofopenIdas security schema at PR #65SessionInvitationNotificationandSessionStatusNotificationat WebRTC Call handling, that became part ofSessionNotificationat PR #56
Merge PR summary:
- Update BYON-Notification-Channel.yaml by @pradeepachar-mavenir in #48
- Update CODEOWNERS by @TEF-RicardoSerr in #49
- Fall 24 Documentation by @TEF-RicardoSerr in #47
- Doc/repo nav pages by @stroncoso-quobis in #46
- Notification compliance by @stroncoso-quobis in #53
- feat(callhandling): VvoipSessionInformation schema reviewed by @stroncoso-quobis in #56
- Fix/api file names by @stroncoso-quobis in #59
- Commonalities alignment for webrtc-events.yaml by @rartych in #66
- Commonalities 0.5 aligment by @stroncoso-quobis in #65
- Registration API - Inline documentation expanded by @stroncoso-quobis in #67
- Call handling API - Inline documentation expanded by @stroncoso-quobis in #68
Full Changelog: v0.1.1...r1.1
CAMARA BYON API v0.1.1
BYON API v0.1.1 is a pre-relese version
Please note
This is a pre-release version, and should be considered as a draft for further development
There are bug fixes and breaking changes to be expected in later versions
The release is suitable for test implementations, but it is not recommended for use in production environments
Added
- Update BYON-CallHandling-Service.yaml - 201 session created, 200 session updated, 204 session updated & examples (check PR44)
Changed
- Update BYON-Calling, BYON-RACM, BYON-Notification: resourceURL to sessionId/channelId (check PR29)
- Documentation is extended and flows diagrams are added (check PR42)
Fixed
NA.
Removed
NA.
CAMARA BYON API v0.1.0
This is the first pre-release of the CAMARA WebRTC API
- API definition
- API documentation
Please note:
This is a pre-release version, and should be considered as a draft for further development
There are bug fixes and breaking changes to be expected in later versions
The release is suitable for test implementations, but it is not recommended for use in production environments
Added
Initial contribution of API spec WebRTC BYON including:
- Registration and Authentication Management
- Notification Handling
- One to One Calling
Changed
This is the first pre-release
Fixed
This is the first pre-release
Removed
This is the first pre-release