Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.
The below sections record the changes for each API version in each release as follows:
- for each first alpha or release-candidate API version, all changes since the release of the previous public API version
- for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
- for a public API version, the consolidated changes since the release of the previous public API version
This patch release contains the definition and documentation of
- device-roaming-status v0.6.1
- device-roaming-status-subscriptions v0.6.1
- device-reachability-status v0.6.1
- device-reachability-status-subscriptions v0.6.1
The API definition(s) are based on
- Commonalities v0.4.0
- Identity and Consent Management v0.2.1
Note: these patch release notes are listing only the change compared to the r1.2 release. For the full list of changes of the 0.6.0 API versions compared to 0.5.x see r1.2.
- API definition with inline documentation:
- Minor corrections in info.description by @akoshunyadi in camaraproject#216
- API definition with inline documentation:
- Add missing
protocol-components for device-roaming-status-subscriptions by @maxl2287 in camaraproject#208 - Correct the examples for sub - initialEvent and error MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED by @dfischer-tech in camaraproject#210
- Minor corrections in info.description by @akoshunyadi in camaraproject#216
- API definition with inline documentation:
- Update description of the reachability types by @akoshunyadi in camaraproject#215
- Minor corrections in info.description by @akoshunyadi in camaraproject#216
- API definition with inline documentation:
- Update description of the reachability types by @akoshunyadi in camaraproject#215
- Correct the examples for sub - initialEvent and error MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED by @dfischer-tech in camaraproject#210
- Minor corrections in info.description by @akoshunyadi in camaraproject#216
Full Changelog: https://github.com/camaraproject/DeviceStatus/compare/r1.2...r1.3
This release contains the definition and documentation of
- device-roaming-status v0.6.0
- device-roaming-status-subscriptions v0.6.0
- device-reachability-status v0.6.0
- device-reachability-status-subscriptions v0.6.0
The API definition(s) are based on
- Commonalities v0.4.0
- Identity and Consent Management v0.2.0
Note: the previous device-status API with roaming and connectivity endpoints has been split into 4 specific APIs
- API definition with inline documentation:
- Addition of "lastStatusTime" Field by @sachinvodafone in camaraproject#146
- include x-correlator by @fernandopradocabrillo in camaraproject#112
- Create Gherkin tests for device-status-reachability and device-status-roaming by @mdomale in camaraproject#186
- Change endpoint names to comply with guideline by @gmuratk in camaraproject#131
- Make '+' mandatory for phoneNumber by @bigludo7 in camaraproject#144
- Separate endpoint yamls proposal for direct API by @bigludo7 in camaraproject#152
- Switch device structure to optional by @bigludo7 in camaraproject#179
device-reachability-status&device-roaming-status: Alignment of errors with Commonalities by @maxl2287 in camaraproject#183- Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in camaraproject#195
- Renamed RequestRoamingStatus to RoamingStatusRequest by @maxl2287 in camaraproject#194
- Remove
terms of serviceandcontactby @maxl2287 in camaraproject#185 - Remove response code 405 by bigludo7 in camaraproject#198
- API definition with inline documentation:
- Add termination reason
SUBSCRIPTION_DELETEDwhen subscription deleted by the user by @maxl2287 in camaraproject#121 - include x-correlator by @fernandopradocabrillo in camaraproject#112
- Create Gherkin tests for device-reachability-status-subscriptions & device-roaming-status-subscriptions by @mdomale in camaraproject#187
- Make '+' mandatory for phoneNumber by @bigludo7 in camaraproject#144
- split
/subscription-endpoints into seperate APIs by @maxl2287 in camaraproject#161 - renaming "EventType"-components to be more clear & update component descriptions by @maxl2287 in camaraproject#141
- Update the subscription models to align on CAMARA commonalities by @maxl2287 in camaraproject#170
- Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in camaraproject#195
- Subscription-APIs: Alignment of errors with Commonalities by @maxl2287 in camaraproject#193
- Remove
terms of serviceandcontactby @maxl2287 in camaraproject#185
- API definition with inline documentation:
- Addition of "lastStatusTime" Field by @sachinvodafone in camaraproject#146
- include x-correlator by @fernandopradocabrillo in camaraproject#112
- Create Gherkin tests for device-status-reachability and device-status-roaming by @mdomale in camaraproject#186
- Change endpoint names to comply with guideline by @gmuratk in camaraproject#131
- Make '+' mandatory for phoneNumber by @bigludo7 in camaraproject#144
- Separate endpoint yamls proposal for direct API by @bigludo7 in camaraproject#152
- Switch device structure to optional by @bigludo7 in camaraproject#179
device-reachability-status&device-roaming-status: Alignment of errors with Commonalities by @maxl2287 in camaraproject#183- Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in camaraproject#195
- Remove
terms of serviceandcontactby @maxl2287 in camaraproject#185 - Remove response code 405 by bigludo7 in camaraproject#198
- API definition with inline documentation:
- Add termination reason
SUBSCRIPTION_DELETEDwhen subscription deleted by the user by @maxl2287 in camaraproject#121 - include x-correlator by @fernandopradocabrillo in camaraproject#112
- Create Gherkin tests for device-reachability-status-subscriptions & device-roaming-status-subscriptions by @mdomale in camaraproject#187
- renaming "EventType"-components to be more clear & update component descriptions by @maxl2287 in camaraproject#141
- Make '+' mandatory for phoneNumber by @bigludo7 in camaraproject#144
- split
/subscription-endpoints into seperate APIs by @maxl2287 in camaraproject#161 - Update the subscription models to align on CAMARA commonalities by @maxl2287 in camaraproject#170
- Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in camaraproject#195
- Subscription-APIs: Alignment of errors with Commonalities by @maxl2287 in camaraproject#193
- Remove
terms of serviceandcontactby @maxl2287 in camaraproject#185
Full Changelog: https://github.com/camaraproject/DeviceStatus/compare/v0.5.1...r1.2
This release contains the definition and documentation of
- device-roaming-status v0.6.0-rc.1
- device-roaming-status-subscriptions v0.6.0-rc.1
- device-reachability-status v0.6.0-rc.1
- device-reachability-status-subscriptions v0.6.0-rc.1
The API definition(s) are based on
- Commonalities v0.4.0-rc.1
- Identity and Consent Management v0.2.0-rc.1
Note: the previous device-status API with roaming and connectivity endpoints has been split into 4 specific APIs
device-roaming-status v0.6.0-rc.1 is the 1st release candidate of the version 0.6
- API definition with inline documentation:
- Addition of "lastStatusTime" Field by @sachinvodafone in camaraproject#146
- include x-correlator by @fernandopradocabrillo in camaraproject#112
- Change endpoint names to comply with guideline by @gmuratk in camaraproject#131
- Make '+' mandatory for phoneNumber by @bigludo7 in camaraproject#144
- Separate endpoint yamls proposal for direct API by @bigludo7 in camaraproject#152
- Switch device structure to optional by @bigludo7 in camaraproject#179
device-reachability-status&device-roaming-status: Alignment of errors with Commonalities by @maxl2287 in camaraproject#183- Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in camaraproject#195
- Renamed RequestRoamingStatus to RoamingStatusRequest by @maxl2287 in camaraproject#194
- Remove
terms of serviceandcontactby @maxl2287 in camaraproject#185
device-roaming-status-subscriptions v0.6.0-rc.1 is the 1st release candidate of the version 0.6
- API definition with inline documentation:
- Add termination reason
SUBSCRIPTION_DELETEDwhen subscription deleted by the user by @maxl2287 in camaraproject#121 - include x-correlator by @fernandopradocabrillo in camaraproject#112
- Make '+' mandatory for phoneNumber by @bigludo7 in camaraproject#144
- split
/subscription-endpoints into seperate APIs by @maxl2287 in camaraproject#161 - renaming "EventType"-components to be more clear & update component descriptions by @maxl2287 in camaraproject#141
- Update the subscription models to align on CAMARA commonalities by @maxl2287 in camaraproject#170
- Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in camaraproject#195
- Subscription-APIs: Alignment of errors with Commonalities by @maxl2287 in camaraproject#193
- Remove
terms of serviceandcontactby @maxl2287 in camaraproject#185
device-reachability-status v0.6.0-rc.1 is the 1st release candidate of the version 0.6
- API definition with inline documentation:
- Addition of "lastStatusTime" Field by @sachinvodafone in camaraproject#146
- include x-correlator by @fernandopradocabrillo in camaraproject#112
- Change endpoint names to comply with guideline by @gmuratk in camaraproject#131
- Make '+' mandatory for phoneNumber by @bigludo7 in camaraproject#144
- Separate endpoint yamls proposal for direct API by @bigludo7 in camaraproject#152
- Switch device structure to optional by @bigludo7 in camaraproject#179
device-reachability-status&device-roaming-status: Alignment of errors with Commonalities by @maxl2287 in camaraproject#183- Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in camaraproject#195
- Remove
terms of serviceandcontactby @maxl2287 in camaraproject#185
device-reachability-status-subscriptions v0.6.0-rc.1 is the 1st release candidate of the version 0.6
- API definition with inline documentation:
- Add termination reason
SUBSCRIPTION_DELETEDwhen subscription deleted by the user by @maxl2287 in camaraproject#121 - include x-correlator by @fernandopradocabrillo in camaraproject#112
- renaming "EventType"-components to be more clear & update component descriptions by @maxl2287 in camaraproject#141
- Make '+' mandatory for phoneNumber by @bigludo7 in camaraproject#144
- split
/subscription-endpoints into seperate APIs by @maxl2287 in camaraproject#161 - Update the subscription models to align on CAMARA commonalities by @maxl2287 in camaraproject#170
- Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in camaraproject#195
- Subscription-APIs: Alignment of errors with Commonalities by @maxl2287 in camaraproject#193
- Remove
terms of serviceandcontactby @maxl2287 in camaraproject#185
Full Changelog: https://github.com/camaraproject/DeviceStatus/compare/v0.5.1...r1.1
- This release contains an alpha version of the API, it should be considered as a draft.
- There are bug fixes to be expected and incompatible changes in upcoming versions.
- API definition with inline documentation:
- Endpoints renamed
- New response parameter lastStatusTime
- Addition of "lastStatusTime" Field by @sachinvodafone in camaraproject#146
- include x-correlator by @fernandopradocabrillo in camaraproject#112
- Change endpoint names to comply with guideline by @gmuratk in camaraproject#131
- renaming "EventType"-components to be more clear & update component descriptions by @maxl2287 in camaraproject#141
- Make '+' mandatory for phoneNumber by @bigludo7 in camaraproject#144
- NA
- NA
- NA
Full Changelog: https://github.com/camaraproject/DeviceStatus/compare/v0.5.1...r0.6
This is a bugfix release for the third initial version of the CAMARA DeviceStatus API
- API definition with inline documentation:
- This is an initial version, it should be considered as a draft.
- There are bug fixes to be expected and incompatible changes in upcoming versions.
- The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
- Minor bugfixes
- Changes in the inline documentation
- NA
- Change description that subscriptionExpireTime is optional by @maxl2287 in camaraproject#120
- Updated in-line documentation for Roaming to clarify that country information can optionally be returned in the response. by @trehman-gsma in camaraproject#127
- fix: move "countryCode" out of "device" in ROAMING_CHANGE_COUNTRY-example by @maxl2287 in camaraproject#106
- fix: add missing "subscriptionId" in "RoamingStatus"-data for CloudEvent by @maxl2287 in camaraproject#109
- fix: change INVALID_INPUT for INVALID_ARGUMENT according to guidelines by @fernandopradocabrillo in camaraproject#129
- NA
- @trehman-gsma made their first contribution in camaraproject#127
- @fernandopradocabrillo made their first contribution in camaraproject#129
Full Changelog: https://github.com/camaraproject/DeviceStatus/compare/v0.5.0...v0.5.1
This is the third initial version of the CAMARA DeviceStatus API
- API definition with inline documentation:
- This release contains significant changes compared to v0.4.1, and it is not backward compatible
- This is an initial version, it should be considered as a draft.
- There are bug fixes to be expected and incompatible changes in upcoming versions.
- The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
- Added a new endpoint (/connectivity) to query the connectivity status of a device.
- Added the support for event notifications, based on CloudEvents, for both roaming and connectivity events.
- Reworked API security, now only Open-ID connect is allowed.
- Added new endpoints to manage event-notifications for roaming events by @bigludo7 in camaraproject#31
- Aligned event notification management with CloudEvents spec and added Open-Id connect as security method by @bigludo7 in camaraproject#75
- Added a new endpoint and events to query the connectivity status of a device by @maxl2287 in camaraproject#69
- Aligned error definition with guidelines by @monamok in camaraproject#35
- Aligned with common usage of allOf by @patrice-conil in camaraproject#60
- Replaced subscriptionId with eventSubscriptionId by @patrice-conil in camaraproject#64
- Corrections resolving linting errors by @rartych in camaraproject#95
- NA
- @bigludo7 made their first contribution in camaraproject#50
- @sachinvodafone made their first contribution in camaraproject#51
- @patrice-conil made their first contribution in camaraproject#59
- @SyeddR made their first contribution in camaraproject#63
- @Sachinsiso made their first contribution in camaraproject#68
- @rartych made their first contribution in camaraproject#79
- @maxl2287 made their first contribution in camaraproject#69
Full Changelog: https://github.com/camaraproject/DeviceStatus/compare/v0.4.1...v0.5.0
This is the release candidate of v0.5.0 - containing the upcoming 3rd initial version of the DeviceStatus API
- API definition with inline documentation:
- This release will contain significant changes compared to v0.4.1, and it is not backward compatible
- This is only the pre-release, it should be considered as a draft of the upcoming release v0.5.0
- The pre-release is meant for implementors, but it is not recommended to use the API with customers in productive environments.
- Added a new endpoint (/connectivity) to query the connectivity status of a device.
- Added the support for event notifications, based on CloudEvents, for both roaming and connectivity events.
- Reworked API security, now only Open-ID connect is allowed.
- Added new endpoints to manage event-notifications for roaming events by @bigludo7 in camaraproject#31
- Aligned event notification management with CloudEvents spec and added Open-Id connect as security method by @bigludo7 in camaraproject#75
- Added a new endpoint and events to query the connectivity status of a device by @maxl2287 in camaraproject#69
- Aligned error definition with guidelines by @monamok in camaraproject#35
- Aligned with common usage of allOf by @patrice-conil in camaraproject#60
- Replaced subscriptionId with eventSubscriptionId by @patrice-conil in camaraproject#64
- NA
- @bigludo7 made their first contribution in camaraproject#50
- @sachinvodafone made their first contribution in camaraproject#51
- @patrice-conil made their first contribution in camaraproject#59
- @SyeddR made their first contribution in camaraproject#63
- @Sachinsiso made their first contribution in camaraproject#68
- @rartych made their first contribution in camaraproject#79
- @maxl2287 made their first contribution in camaraproject#69
Full Changelog: https://github.com/camaraproject/DeviceStatus/compare/v0.4.1...v0.5.0
- API definition
- API documentation
- 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
- Add new return parameters MCC (Mobile Country Code) and ISO 3166-1 alpha-2 Country Code by @ravindrapalaskar17 in camaraproject#21
- API simplified by @monamok in camaraproject#23
- base path renamed to
device-status /statuspath renamed to/roaming- required status type is now implicit from path name, and does not need to be passed by parameter
eventType
- base path renamed to
- Fix typo in filename and in CountryName response field by @ravindrapalaskar17 in camaraproject#30
- Objects
ConnectivityEventTypeandEventStatusType
- @ravindrapalaskar17 made their first contribution in camaraproject#21
Full Changelog: https://github.com/camaraproject/DeviceStatus/compare/v0.2.0...v0.4.1
- API definition
- API documentation
- 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
- Initial contribution of API spec check-device-connectivity v0.2.0 by @akoshunyadi in camaraproject#5
- Upload Roaming API Proposal - Vodafone.md by @eric-murray in camaraproject#12
- Add documentation by @paweltalar in camaraproject#8
- This is the first pre-release
- This is the first pre-release
- This is the first pre-release
- @eric-murray made their first contribution in camaraproject#1
- @JoachimDahlgren made their first contribution in camaraproject#3
- @akoshunyadi made their first contribution in camaraproject#5
- @paweltalar made their first contribution in camaraproject#8
- @shilpa-padgaonkar made their first contribution in camaraproject#13
- @NoelWirzius made their first contribution in camaraproject#16
Full Changelog: https://github.com/camaraproject/DeviceStatus/commits/v0.2.0