r1.2

This public release contains the definition and documentation of

• location-verification v1.0.0
• location-retrieval v0.3.0
• geofencing-subscriptions v0.3.0

The API definition(s) are based on

• Commonalities v0.4.0
• Identity and Consent Management v0.2.0

Changelog since v0.2.0

• Full Changelog with the list of PRs and contributors: v0.2.0...r1.2

location-verification v1.0.0

Added

• Added x-correlator to requests and headers
• Enhancements in documentation
• Testing plan

Changed

• Make device optional in requests, with related documentation
• Make '+' mandatory for phoneNumber
• Adjust maxAge behaviour and minimum, and adjust documentation
• Alignment of errors with Commonalities

Fixed

• Update the PARTIAL case description: match_rate is set in the response

location-retrieval v0.3.0

Added

• Added x-correlator to requests and headers
• Enhancements in documentation
• Testing plan

Changed

• Make device optional in requests, with related documentation
• Make '+' mandatory for phoneNumber
• Adjust maxAge behaviour and minimum, and adjust documentation
• Alignment of errors with Commonalities

Fixed

• Clarify that lastLocationTime is mandatory in responses

geofencing-subscriptions v0.3.0

Added

• Adopt Commonalities guidelines for subscriptions (based on CloudEvents)
• Add subscriptionMaxEvents for maximum number of notifications
• Add SUBSCRIPTION_DELETED and SUBSCRIPTION_UNPROCESSABLE as termination reasons
• Add terminationsDescription as optional event property
• Added x-correlator to requests and headers
• Enhancements in documentation
• Testing plan

Changed

• Change base path to geofencing-subscriptions and adapt security scopes
• Make '+' mandatory for phoneNumber
• Alignment of errors with Commonalities

r1.1

Release Notes

This release contains the definition and documentation of

• location-verification v1.0.0-rc.1
• location-retrieval v0.3.0-rc.1
• geofencing-subscriptions v0.3.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

location-verification v1.0.0-rc.1

Added

• Added x-correlator to requests and headers
• Enhancements in documentation
• Testing plan

Changed

• Make device optional in requests, with related documentation
• Make '+' mandatory for phoneNumber
• Adjust maxAge behaviour and minimum, and adjust documentation
• Alignment of errors with Commonalities

Fixed

• Update the PARTIAL case description: match_rate is set in the response

location-retrieval v0.3.0-rc.1

Added

• Added x-correlator to requests and headers
• Enhancements in documentation
• Testing plan

Changed

• Make device optional in requests, with related documentation
• Make '+' mandatory for phoneNumber
• Adjust maxAge behaviour and minimum, and adjust documentation
• Alignment of errors with Commonalities

Fixed

• Clarify that lastLocationTime is mandatory in responses

geofencing-subscriptions v0.3.0-rc.1

Added

• Adopt Commonalities guidelines for subscriptions (based on CloudEvents)
• Add subscriptionMaxEvents for maximum number of notifications
• Add SUBSCRIPTION_DELETED as termination-reason
• Added x-correlator to requests and headers
• Enhancements in documentation
• Testing plan

Changed

• Change base path to geofencing-subscriptions and adapt security scopes
• Make '+' mandatory for phoneNumber
• Alignment of errors with Commonalities

New Contributors

• @hdamker made their first contribution in #204
• @jgarciahospital made their first contribution in #226

Full Changelog: v0.2.0...r1.1

v0.2.0

This is the second alpha version of the Device Location API family

• API definition with inline documentation.

Please note:

• This release contains significant breaking changes compared to v0.1.0, and it is not backward compatible
  • Especially a lot of the parameter names changed in line with the agreed glossary within CAMARA Commonalities
• This is an alpha 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 implementers, but it is not recommended to use the API with customers in productive environments.

What's changed

• Second alpha version of location-verification API, v0.2.0, renamed from location, with main changes:

  • Input property ueId evolved to device, following CAMARA guidelines.
  • New input parameter area, considering initially circular areas, and deprecating previous latitude, longitude and accuracy properties.
  • New input parameter maxAge.
  • Response adds new values UNKNOWN and PARTIAL for verificationResult. It also adds properties matchRate and lastLocationTime.
  • Security schemas and scopes aligned with commonalities guidelines.
  • Error responses adapted to new commonalities guidelines.
  • Inline documentation within OpenAPI spec.

• First alpha version of the new API location-retrieval, v0.1.0:

  • Initial version already aligned with latest guidelines.
  • Returns 2 possible location areas: Circle and Polygon.

• First alpha version of the new API geofencing, v0.1.0:

  • Initial version already aligned with latest guidelines.
  • Follows CloudEvents format.

New Contributors

• @ukkaps made their first contribution in #9
• @VijayKesharwani made their first contribution in #22
• @rartych made their first contribution in #35
• @maheshc01 made their first contribution in #41
• @bigludo7 made their first contribution in #46
• @hbujakow made their first contribution in #53
• @maxl2287 made their first contribution in #98
• @eric-murray made their first contribution in #103

Full Changelog: v0.1.0...v0.2.0

v0.1.0

This is the first alpha version of the Device Location API.

• API definition
• API documentation

Please note:

• This is an alpha 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.

What's Changed

• Initial contribution of API spec location.yaml v0.1.0 by @akoshunyadi in #3
• Create Location_API.md by @jlurien in #11

New Contributors

• @akoshunyadi made their first contribution in #3
• @JoachimDahlgren made their first contribution in #1
• @shilpa-padgaonkar made their first contribution in #10
• @jlurien made their first contribution in #11

Full Changelog: https://github.com/camaraproject/DeviceLocation/commits/v0.1.0