diff --git a/CHANGELOG/CHANGELOG-r4.md b/CHANGELOG/CHANGELOG-r4.md new file mode 100644 index 00000000..f7e5a703 --- /dev/null +++ b/CHANGELOG/CHANGELOG-r4.md @@ -0,0 +1,157 @@ +# Changelog DeviceLocation + + +## Table of Contents +- [r4.1](#r41) + + +**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 an alpha release, the delta with respect to the previous release +* for the first release-candidate, all changes since the last public release +* for subsequent release-candidate(s), only the delta to the previous release-candidate +* for a public release, the consolidated changes since the previous public release + +# r4.1 + +## Release Notes + +This release candidate contains the definition and documentation of +* geofencing-subscriptions 0.6.0-rc.1 +* location-retrieval 1.0.0-rc.1 +* location-verification 3.1.0-rc.2 + +The API definition(s) are based on +* Commonalities 0.8.0 +* Identity and Consent Management 0.5.0 + + +> **Working area — candidate changes (auto-removed on merge)** +> Copy relevant entries into the Breaking changes/Added/Changed/Fixed/Removed sections below. List breaking changes both in Breaking changes and in their normal change category. +> You may edit this list while triaging; it will be removed on merge. +> This working-area section is removed automatically when the PR is merged. + +
+Candidate changes (auto-generated from merged PRs) + +## What's Changed +* Revert versions to WIP in main by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/378 +* [bulk] Sync Release Information section (2025-12-12-001) by @hdamker-bot in https://github.com/camaraproject/DeviceLocation/pull/383 +* Enhance Area object with description by @bigludo7 in https://github.com/camaraproject/DeviceLocation/pull/382 +* Explicit minimum of 0 to maxAge by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/386 +* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/DeviceLocation/pull/387 +* Update README.md by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/391 +* Update scenarios for non-existent and unable to locate devices by @bigludo7 in https://github.com/camaraproject/DeviceLocation/pull/390 +* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceLocation/pull/398 +* Update release-plan.yaml by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/400 +* Update release-plan.yaml by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/402 +* Geofencing Subscriptions: Add support for PRIVATE_KEY_JWT by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/393 +* fix: declare CloudEvent schema type by @bigludo7 in https://github.com/camaraproject/DeviceLocation/pull/406 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceLocation/pull/403 +* Update release-plan.yaml by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/407 +* fix validation rc Sync26 by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/408 +* test: align DeviceLocation test plans with specs and r4.3 artifacts by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/414 + +## New Contributors +* @camara-release-automation[bot] made their first contribution in https://github.com/camaraproject/DeviceLocation/pull/398 + +
+ + +## geofencing-subscriptions 0.6.0-rc.1 + +**geofencing-subscriptions 0.6.0-rc.1 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.5.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/geofencing-subscriptions.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/geofencing-subscriptions.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceLocation/blob/r4.1/code/API_definitions/geofencing-subscriptions.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* N/A + +### Removed + +* N/A + +## location-retrieval 1.0.0-rc.1 + +**location-retrieval 1.0.0-rc.1 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.5.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/location-retrieval.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/location-retrieval.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceLocation/blob/r4.1/code/API_definitions/location-retrieval.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* N/A + +### Removed + +* N/A + +## location-verification 3.1.0-rc.2 + +**location-verification 3.1.0-rc.2 is a release-candidate version of this API.** + +Changes documented below are compared to version 3.0.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/location-verification.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/location-verification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceLocation/blob/r4.1/code/API_definitions/location-verification.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* N/A + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/DeviceLocation/compare/r3.2...r4.1 + diff --git a/README.md b/README.md index c2bd27ee..ef9634b6 100644 --- a/README.md +++ b/README.md @@ -32,22 +32,28 @@ Incubating API Repository to evolve and maintain the definitions and documentati > [!NOTE] > 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. -* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/DeviceLocation/releases/tag/r3.2) (Fall25), with the following API versions: - * **geofencing-subscriptions v0.5.0** - [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/geofencing-subscriptions.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/geofencing-subscriptions.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/geofencing-subscriptions.yaml) - * **location-retrieval v0.5.0** - [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-retrieval.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-retrieval.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-retrieval.yaml) - * **location-verification v3.0.0** - [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-verification.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-verification.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-verification.yaml) +* The latest public release is [r3.2](https://github.com/camaraproject/DeviceLocation/releases/tag/r3.2), with the following API versions: + * **geofencing-subscriptions 0.5.0** + [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/geofencing-subscriptions.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/geofencing-subscriptions.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/geofencing-subscriptions.yaml) + * **location-retrieval 0.5.0** + [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-retrieval.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-retrieval.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-retrieval.yaml) + * **location-verification 3.0.0** + [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-verification.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-verification.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/code/API_definitions/location-verification.yaml) + * The latest public release is always available here: https://github.com/camaraproject/DeviceLocation/releases/latest * Other releases of this repository are available in https://github.com/camaraproject/DeviceLocation/releases -* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceLocation/blob/main/CHANGELOG.md) +* For changes see [CHANGELOG](https://github.com/camaraproject/DeviceLocation/tree/main/CHANGELOG) + +### Upcoming Release Preview + +* Pre-release: [r4.1](https://github.com/camaraproject/DeviceLocation/releases/tag/r4.1) (release candidate) + * **geofencing-subscriptions 0.6.0-rc.1** + [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r4.1/code/API_definitions/geofencing-subscriptions.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/geofencing-subscriptions.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/geofencing-subscriptions.yaml) + * **location-retrieval 1.0.0-rc.1** + [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r4.1/code/API_definitions/location-retrieval.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/location-retrieval.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/location-retrieval.yaml) + * **location-verification 3.1.0-rc.2** + [[YAML]](https://github.com/camaraproject/DeviceLocation/blob/r4.1/code/API_definitions/location-verification.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/location-verification.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r4.1/code/API_definitions/location-verification.yaml) + _The above section is automatically synchronized by CAMARA project-administration._