From 5e5b585e75cf58a3276b50ed863e4318a5fdb92e Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Fri, 29 Aug 2025 12:17:41 +0200 Subject: [PATCH 01/12] Prepare public release r3.2 --- CHANGELOG.md | 107 +++++++++++++++++- README.md | 32 +++--- .../geofencing-subscriptions.yaml | 4 +- code/API_definitions/location-retrieval.yaml | 4 +- .../location-verification.yaml | 4 +- .../geofencing-subscriptions.feature | 4 +- .../location-retrieval.feature | 4 +- .../location-verification.feature | 4 +- ...g-subscriptions-API-Readiness-Checklist.md | 8 +- ...ation-retrieval-API-Readiness-Checklist.md | 8 +- ...on-verification-API-Readiness-Checklist.md | 8 +- 11 files changed, 145 insertions(+), 42 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b286d2bd..a3bcfd54 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,8 +2,9 @@ ## Table of Contents +- **[r3.2](#r32) (Fall25 public release)** - [r3.1](#r31) -- **[r2.2](#r21) (Spring25 public release)** +- **[r2.2](#r22) (Spring25 public release)** - [r2.1](#r21) - **[r1.2](#r12) (Fall24 public release)** - [r1.1](#r11) @@ -19,6 +20,110 @@ The below sections record the changes for each API version in each release as fo * 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 +# r3.2 + +This **public release** contains the definition and documentation of +* location-verification v3.0.0 +* location-retrieval v0.5.0 +* geofencing-subscriptions v0.5.0 + +The API definition(s) are based on +* Commonalities r3.3 +* Identity and Consent Management r3.3 + +## location-verification v3.0.0 + +location-verification v3.0.0 is the public release for the next stable version of the API Location Verification. It introduces breaking changes compared to the previous release r2.2, due to the deprecation of `UNKNOWN` value for `verificationResult` in favor of the new error `422 LOCATION_VERIFICATION.UNABLE_TO_LOCATE`. + +* API definition with **inline documentation**: + + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/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/r3.2/code/API_definitions/location-verification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-verification.yaml) + +### Added + +* New error code `422 LOCATION_VERIFICATION.UNABLE_TO_LOCATE`. +* New `DeviceResponse` object in responses limited to one identifier. +* Clarifications on non-documented error responses. + +### Changed + +* Updated string pattern for `x-correlator`headers. +* Type of `radius` for CIRCLE Area changed from `integer` to `number`, and maximum removed. +* Clarified format for properties with format `date-time`. + +### Removed + +* `verificationResult: UNKNOWN` for 200 responses. +* Error `422 IDENTIFIER_MISMATCH`. +* Error `401 AUTHENTICATION_REQUIRED`. + +## location-retrieval v0.5.0 + +location-retrieval v0.5.0 is the public release for the next initial version of the API Location Retrieval. It introduces breaking changes compared to the previous release r2.2, due to the deprecation of error `404 LOCATION_RETRIEVAL.DEVICE_NOT_FOUND` in favor of the new error `422 LOCATION_RETRIEVAL.UNABLE_TO_LOCATE`. + +* API definition with **inline documentation**: + + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/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/r3.2/code/API_definitions/location-retrieval.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-retrieval.yaml) + +### Added + +* New error `422 LOCATION_RETRIEVAL.UNABLE_TO_LOCATE`. +* New `DeviceResponse` object in responses limited to one identifier. +* Clarifications on non-documented error responses. + +### Changed + +* Updated string pattern for `x-correlator`headers. +* Clarified format for properties with format `date-time`. + +### Removed + +* Error `404 LOCATION_RETRIEVAL.DEVICE_NOT_FOUND`. +* Error `422 IDENTIFIER_MISMATCH`. +* Error `401 AUTHENTICATION_REQUIRED`. + +## geofencing-subscriptions v0.5.0 + +geofencing-subscriptions v0.5.0 is the public release for the next initial version of the API Geofencing Subscriptions. It introduces breaking changes compared to the previous release r2.2, coming from the alignment to the new guidelines in Commonalities for APIs with subscriptions. + +* API definition with **inline documentation**: + + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/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/r3.2/code/API_definitions/geofencing-subscriptions.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/geofencing-subscriptions.yaml) + +### Added + +* New subscription event types for `subscription-started` and `subscription-updated`. +* New `DeviceResponse` object in responses and events, limited to one identifier. +* Pattern to property `sink` and new error `400 INVALID_SINK`. +* Clarifications on non-documented error responses. + +### Changed + +* Subscription event type `subscription-ends` renamed to `subscription-ended`. +* Property `id` becomes required for `SubscriptionAsync` objects. +* operationId `createSubscription` renamed to `createGeofencingSubscription`. +* Updated string pattern for `x-correlator`headers. +* Type of `radius` for CIRCLE Area changed from `integer` to `number`, and maximum removed. +* Clarified format for properties with format `date-time`. + +### Fixed + +* Subscription types array items must be limited to allowed `SubscriptionEventType` values + +### Removed + +* Error `422 IDENTIFIER_MISMATCH`. +* Error `401 AUTHENTICATION_REQUIRED`. + +**Changelog since r2.2** +* Full Changelog with the list of PRs and contributors: https://github.com/camaraproject/DeviceLocation/compare/r2.2...r3.2 + # r3.1 ## Release Notes diff --git a/README.md b/README.md index a7483ec8..9fe937f0 100644 --- a/README.md +++ b/README.md @@ -31,24 +31,22 @@ 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**: Pre-release [r3.1](https://github.com/camaraproject/DeviceLocation/releases/tag/r3.1) with location-verification v3.0.0-rc.1, location-retrieval v0.5.0-rc.1 and geofencing-subscriptions v0.5.0-rc.1 is available. - -* **The latest public release is [r2.2](https://github.com/camaraproject/DeviceLocation/tree/r2.2), with the following API definitions (with inline documentation):** +* **The latest public release is [r3.2](https://github.com/camaraproject/DeviceLocation/tree/r3.2), with the following API definitions (with inline documentation):** - - **location-verification v2.0.0** - [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.2/code/API_definitions/location-verification.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.2/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/r2.2/code/API_definitions/location-verification.yaml) - - - **location-retrieval v0.4.0** - [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.2/code/API_definitions/location-retrieval.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.2/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/r2.2/code/API_definitions/location-retrieval.yaml) - - - **geofencing-subscriptions v0.4.0** - [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.2/code/API_definitions/geofencing-subscriptions.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.2/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/r2.2/code/API_definitions/geofencing-subscriptions.yaml) + - **location-verification v3.0.0** + [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-verification.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/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/r3.2/code/API_definitions/location-verification.yaml) + + - **location-retrieval v0.5.0** + [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-retrieval.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/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/r3.2/code/API_definitions/location-retrieval.yaml) + + - **geofencing-subscriptions v0.5.0** + [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/geofencing-subscriptions.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r3.2/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/r3.2/code/API_definitions/geofencing-subscriptions.yaml) ## Contributing diff --git a/code/API_definitions/geofencing-subscriptions.yaml b/code/API_definitions/geofencing-subscriptions.yaml index e2b1f23c..f98bece2 100644 --- a/code/API_definitions/geofencing-subscriptions.yaml +++ b/code/API_definitions/geofencing-subscriptions.yaml @@ -114,7 +114,7 @@ info: (FAQs will be added in a later version of the documentation) - version: wip + version: 0.5.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -124,7 +124,7 @@ externalDocs: url: https://github.com/camaraproject/DeviceLocation servers: - - url: "{apiRoot}/geofencing-subscriptions/vwip" + - url: "{apiRoot}/geofencing-subscriptions/v0.5" variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index 6fb3c5e1..a009959d 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -108,7 +108,7 @@ info: # Further info and support (FAQs will be added in a later version of the documentation) - version: wip + version: 0.5.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -117,7 +117,7 @@ externalDocs: description: Project documentation at Camara url: https://github.com/camaraproject/DeviceLocation servers: - - url: '{apiRoot}/location-retrieval/vwip' + - url: '{apiRoot}/location-retrieval/v0.5' variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/location-verification.yaml b/code/API_definitions/location-verification.yaml index 9a4f6ef8..5acc3541 100644 --- a/code/API_definitions/location-verification.yaml +++ b/code/API_definitions/location-verification.yaml @@ -92,7 +92,7 @@ info: # Further info and support (FAQs will be added in a later version of the documentation) - version: wip + version: 3.0.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -101,7 +101,7 @@ externalDocs: description: Project documentation at CAMARA url: https://github.com/camaraproject/DeviceLocation servers: - - url: "{apiRoot}/location-verification/vwip" + - url: "{apiRoot}/location-verification/v3" variables: apiRoot: default: http://localhost:9091 diff --git a/code/Test_definitions/geofencing-subscriptions.feature b/code/Test_definitions/geofencing-subscriptions.feature index e929ca7e..7d5dde97 100644 --- a/code/Test_definitions/geofencing-subscriptions.feature +++ b/code/Test_definitions/geofencing-subscriptions.feature @@ -1,4 +1,4 @@ -Feature: Camara Geofencing Subscriptions API, vwip - Operations on subscriptions +Feature: Camara Geofencing Subscriptions API, v0.5.0 - Operations on subscriptions # Input to be provided by the implementation to the tester # @@ -12,7 +12,7 @@ Feature: Camara Geofencing Subscriptions API, vwip - Operations on subscriptions # References to OAS spec schemas refer to schemas specifies in geofencing-subscriptions.yaml Background: Common Geofencing Subscriptions setup - Given the resource "{apiroot}/geofencing-subscriptions/vwip/" as geofencing base-url + Given the resource "{apiroot}/geofencing-subscriptions/v0.5/" as geofencing base-url And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/code/Test_definitions/location-retrieval.feature b/code/Test_definitions/location-retrieval.feature index 51d21875..7276bfb9 100644 --- a/code/Test_definitions/location-retrieval.feature +++ b/code/Test_definitions/location-retrieval.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Device location retrieval API, vwip - Operation retrieveLocation +Feature: CAMARA Device location retrieval API, v0.5.0 - Operation retrieveLocation # Input to be provided by the implementation to the tester # # Implementation indications: @@ -12,7 +12,7 @@ Feature: CAMARA Device location retrieval API, vwip - Operation retrieveLocation # References to OAS spec schemas refer to schemas specifies in location-retrieval.yaml Background: Common retrieveLocation setup - Given the resource "/location-retrieval/vwip/retrieve" | + Given the resource "/location-retrieval/v0.5/retrieve" | And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/code/Test_definitions/location-verification.feature b/code/Test_definitions/location-verification.feature index 72e98e0c..824f0ca5 100644 --- a/code/Test_definitions/location-verification.feature +++ b/code/Test_definitions/location-verification.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Device location verification API, vwip - Operation verifyLocation +Feature: CAMARA Device location verification API, v3.0.0 - Operation verifyLocation # Input to be provided by the implementation to the tester # # Implementation indications: @@ -12,7 +12,7 @@ Feature: CAMARA Device location verification API, vwip - Operation verifyLocatio # References to OAS spec schemas refer to schemas specifies in location-verification.yaml Background: Common verifyLocation setup - Given the resource "/location-verification/vwip/verify" + Given the resource "/location-verification/v3/verify" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md index c1b878fa..3dba700f 100644 --- a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md @@ -1,18 +1,18 @@ # API Readiness Checklist -Checklist for geofencing-subscriptions 0.5.0-rc.1 in r3.1 +Checklist for geofencing-subscriptions 0.5.0 in r3.2 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------------------------:|:-------------------------:|:------:|:------------------------------------------------------------------------------------------------------------------:| | 1 | API definition | M | M | M | M | Y | [/code/API_definitions/geofencing-subscriptions.yaml](/code/API_definitions/geofencing-subscriptions.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.2 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.2 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | inline in yaml | | 6 | User stories | O | O | O | M | N | | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/geofencing-subscriptions.feature](/code/Test_definitions/geofencing-subscriptions.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [/code/Test_definitions/geofencing-subscriptions.feature](/code/Test_definitions/geofencing-subscriptions.feature) | -| 9 | Test result statement | O | O | O | M | N | Test results not available (*) | +| 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) | | 12 | Previous public-release was certified | O | O | O | M | N | | diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index fd868cf0..c0f26d1c 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -1,18 +1,18 @@ # API Readiness Checklist -Checklist for location-retrieval 0.5.0-rc.1 in r3.1 +Checklist for location-retrieval 0.5.0 in r3.2 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------------------------:|:-------------------------:|:------:|:------------------------------------------------------------------------------------------------------:| | 1 | API definition | M | M | M | M | Y | [/code/API_definitions/location-retrieval.yaml](/code/API_definitions/location-retrieval.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.2 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.2 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | inline in yaml | | 6 | User stories | O | O | O | M | N | | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/location-retrieval.feature](/code/Test_definitions/location-retrieval.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [/code/Test_definitions/location-retrieval.feature](/code/Test_definitions/location-retrieval.feature) | -| 9 | Test result statement | O | O | O | M | N | Test results not available (*) | +| 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) | | 12 | Previous public-release was certified | O | O | O | M | N | | diff --git a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md index 315dfc0b..eed635e8 100644 --- a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md @@ -1,18 +1,18 @@ # API Readiness Checklist -Checklist for location-verification 3.0.0-rc.1 in r3.1 +Checklist for location-verification 3.0.0 in r3.2 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------------------------:|:-------------------------:|:------:|:--------------------------------------------------------------------------------------------------------------------------------------------:| | 1 | API definition | M | M | M | M | Y | [/code/API_definitions/location-verification.yaml](/code/API_definitions/location-verification.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.2 | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.2 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | inline in yaml | | 6 | User stories | O | O | O | M | Y | [/documentation/API_documentation/location-verification-User-Story.md](/documentation/API_documentation/location-verification-User-Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/location-verification.feature](/code/Test_definitions/location-verification.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [/code/Test_definitions/location-verification.feature](/code/Test_definitions/location-verification.feature) | -| 9 | Test result statement | O | O | O | M | Y | https://github.com/camaraproject/DeviceLocation/issues/296 | +| 9 | Test result statement | O | O | O | M | ? | https://github.com/camaraproject/DeviceLocation/issues/372 | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | Y | | From 1839dd569db271e189413bec74a834f3b6706cae Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Mon, 1 Sep 2025 11:17:34 +0200 Subject: [PATCH 02/12] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a3bcfd54..76198159 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -222,6 +222,7 @@ geofencing-subscriptions v0.5.0-rc.1 is the first release candidate for the next * Error `422 IDENTIFIER_MISMATCH`. * Error `401 AUTHENTICATION_REQUIRED`. + # r2.2 ## Release Notes From 266ee15efda93c0f9df80af77cfbe75a42156921 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Tue, 2 Sep 2025 16:53:37 +0200 Subject: [PATCH 03/12] Update location-retrieval.feature --- code/Test_definitions/location-retrieval.feature | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/location-retrieval.feature b/code/Test_definitions/location-retrieval.feature index 1a1878ae..c34f2536 100644 --- a/code/Test_definitions/location-retrieval.feature +++ b/code/Test_definitions/location-retrieval.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Device location retrieval API, vwip - Operation retrieveLocation +Feature: CAMARA Device location retrieval API, v0.5.0 - Operation retrieveLocation # Input to be provided by the implementation to the tester # # Implementation indications: @@ -12,7 +12,7 @@ Feature: CAMARA Device location retrieval API, vwip - Operation retrieveLocation # References to OAS spec schemas refer to schemas specifies in location-retrieval.yaml Background: Common retrieveLocation setup - Given the resource "/location-retrieval/vwip/retrieve" | + Given the resource "/location-retrieval/v0.5/retrieve" | And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" From 404d60b208002b4547961b558b1a62ac332bdfd5 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Tue, 2 Sep 2025 16:57:32 +0200 Subject: [PATCH 04/12] Update location-verification-API-Readiness-Checklist.md --- .../location-verification-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md index eed635e8..45cca481 100644 --- a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md @@ -12,7 +12,7 @@ Checklist for location-verification 3.0.0 in r3.2 | 6 | User stories | O | O | O | M | Y | [/documentation/API_documentation/location-verification-User-Story.md](/documentation/API_documentation/location-verification-User-Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions/location-verification.feature](/code/Test_definitions/location-verification.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [/code/Test_definitions/location-verification.feature](/code/Test_definitions/location-verification.feature) | -| 9 | Test result statement | O | O | O | M | ? | https://github.com/camaraproject/DeviceLocation/issues/372 | +| 9 | Test result statement | O | O | O | M | ? | https://github.com/camaraproject/DeviceLocation/issues/371 | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | Y | | From 54aef364ddffe0932effc4fe0fc51299a779ef72 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Sep 2025 11:08:33 +0200 Subject: [PATCH 05/12] Update README.md Co-authored-by: Kevin Smith --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9fe937f0..ec9b7e77 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ 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**. -* **The latest public release is [r3.2](https://github.com/camaraproject/DeviceLocation/tree/r3.2), with the following API definitions (with inline documentation):** +* **NEW: public release** [r3.2](https://github.com/camaraproject/DeviceLocation/releases/r3.2) is available, with the following API definitions (with inline documentation):** - **location-verification v3.0.0** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r3.2/code/API_definitions/location-verification.yaml) From f37a30fb560fd89a7305dd33f2d137d2279f074a Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Sep 2025 11:11:45 +0200 Subject: [PATCH 06/12] Update geofencing-subscriptions.feature --- code/Test_definitions/geofencing-subscriptions.feature | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/code/Test_definitions/geofencing-subscriptions.feature b/code/Test_definitions/geofencing-subscriptions.feature index 74d79194..1d23e8e5 100644 --- a/code/Test_definitions/geofencing-subscriptions.feature +++ b/code/Test_definitions/geofencing-subscriptions.feature @@ -8,11 +8,13 @@ Feature: Camara Geofencing Subscriptions API, v0.5.0 - Operations on subscriptio # Testing assets: # * A device object which location is known by the network when connected. 2 distinct device are required for some scenario. # * A moveable device to trigger area-left / area-entered events. + # * apiRoot: API root of the server URL # # References to OAS spec schemas refer to schemas specifies in geofencing-subscriptions.yaml Background: Common Geofencing Subscriptions setup - Given the resource "{apiroot}/geofencing-subscriptions/v0.5/" as geofencing base-url + Given an environment at "apiRoot" + And the resource "/geofencing-subscriptions/v0.5/" as geofencing base-url And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" From ec76fa0c0e2f2a54c763bea430446492a0292c13 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Sep 2025 11:12:52 +0200 Subject: [PATCH 07/12] Update location-retrieval.feature --- code/Test_definitions/location-retrieval.feature | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/location-retrieval.feature b/code/Test_definitions/location-retrieval.feature index 9ddd91fc..46f70d8a 100644 --- a/code/Test_definitions/location-retrieval.feature +++ b/code/Test_definitions/location-retrieval.feature @@ -8,11 +8,13 @@ Feature: CAMARA Device location retrieval API, v0.5.0 - Operation retrieveLocati # * A device object which location is known by the network when connected. 2 distinct device are required for some scenario. # * A device object identifying a device commercialized by the implementation for which the service is not applicable # * A device object which location cannot be provided during test by the network. + # * apiRoot: API root of the server URL # # References to OAS spec schemas refer to schemas specifies in location-retrieval.yaml Background: Common retrieveLocation setup - Given the resource "/location-retrieval/v0.5/retrieve" | + Given an environment at "apiRoot" + And the resource "/location-retrieval/v0.5/retrieve" | And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" @@ -261,4 +263,4 @@ Feature: CAMARA Device location retrieval API, v0.5.0 - Operation retrieveLocati And the response header "x-correlator" has same value as the request header "x-correlator" And the response property "$.status" is 422 And the response property "$.code" is "LOCATION_RETRIEVAL.UNABLE_TO_FULFILL_MAX_AGE" - And the response property "$.message" contains a user friendly text \ No newline at end of file + And the response property "$.message" contains a user friendly text From 59b10b48ff73317e819ec615eed52f269e312748 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Sep 2025 11:14:29 +0200 Subject: [PATCH 08/12] Update location-verification.feature --- code/Test_definitions/location-verification.feature | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/location-verification.feature b/code/Test_definitions/location-verification.feature index 816a641e..3355b454 100644 --- a/code/Test_definitions/location-verification.feature +++ b/code/Test_definitions/location-verification.feature @@ -8,11 +8,13 @@ Feature: CAMARA Device location verification API, v3.0.0 - Operation verifyLocat # * A device object which location is known by the network when connected. To test all scenarios, at least 2 valid devices are needed # * The known location of the testing devices # * A device object identifying a device commercialized by the implementation for which the service is not applicable, if any + # * apiRoot: # # References to OAS spec schemas refer to schemas specifies in location-verification.yaml Background: Common verifyLocation setup - Given the resource "/location-verification/v3/verify" + Given an environment at "apiRoot" + And the resource "/location-verification/v3/verify" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" @@ -308,4 +310,5 @@ Feature: CAMARA Device location verification API, v3.0.0 - Operation verifyLocat Then the response status code is 422 And the response property "$.status" is 422 And the response property "$.code" is "LOCATION_VERIFICATION.UNABLE_TO_LOCATE" - And the response property "$.message" contains a user-friendly text \ No newline at end of file + + And the response property "$.message" contains a user-friendly text From a48559ee3bb28cf7710c92e2c3983a092bdbabf7 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Sep 2025 11:14:44 +0200 Subject: [PATCH 09/12] Update location-verification.feature --- code/Test_definitions/location-verification.feature | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/Test_definitions/location-verification.feature b/code/Test_definitions/location-verification.feature index 3355b454..91bb6e7b 100644 --- a/code/Test_definitions/location-verification.feature +++ b/code/Test_definitions/location-verification.feature @@ -8,7 +8,7 @@ Feature: CAMARA Device location verification API, v3.0.0 - Operation verifyLocat # * A device object which location is known by the network when connected. To test all scenarios, at least 2 valid devices are needed # * The known location of the testing devices # * A device object identifying a device commercialized by the implementation for which the service is not applicable, if any - # * apiRoot: + # * apiRoot: API root of the server URL # # References to OAS spec schemas refer to schemas specifies in location-verification.yaml @@ -312,3 +312,4 @@ Feature: CAMARA Device location verification API, v3.0.0 - Operation verifyLocat And the response property "$.code" is "LOCATION_VERIFICATION.UNABLE_TO_LOCATE" And the response property "$.message" contains a user-friendly text + From 975adbc7e24bdaa99c414023ecc3daf84690ad4e Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Sep 2025 11:19:38 +0200 Subject: [PATCH 10/12] Update CHANGELOG.md --- CHANGELOG.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 76198159..130c0f9c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -33,7 +33,9 @@ The API definition(s) are based on ## location-verification v3.0.0 -location-verification v3.0.0 is the public release for the next stable version of the API Location Verification. It introduces breaking changes compared to the previous release r2.2, due to the deprecation of `UNKNOWN` value for `verificationResult` in favor of the new error `422 LOCATION_VERIFICATION.UNABLE_TO_LOCATE`. +location-verification v3.0.0 is the public release for the next stable version of the API Location Verification. + +**There is breaking change compared to the previous release r2.2**, due to the deprecation of `UNKNOWN` value for `verificationResult` in favor of the new error `422 LOCATION_VERIFICATION.UNABLE_TO_LOCATE`. * API definition with **inline documentation**: @@ -692,3 +694,4 @@ The API definition(s) are based on * New API `location`, v0.1.0, with a single operation for location verification: - Given a device identified by the `ueId` object, a set of coordinates (`latitude` and `longitude`), and the requested `accuracy`, returns a boolean `verificationResult`, verifying if the device is within the circular area delimited by the coordinates and the accuracy radius. + From 23c6ee0c6bda6612f8bdae6b489fef54af8e8c76 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Sep 2025 11:23:31 +0200 Subject: [PATCH 11/12] Update geofencing-subscriptions.yaml --- code/API_definitions/geofencing-subscriptions.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/geofencing-subscriptions.yaml b/code/API_definitions/geofencing-subscriptions.yaml index f33594d2..8ae7942d 100644 --- a/code/API_definitions/geofencing-subscriptions.yaml +++ b/code/API_definitions/geofencing-subscriptions.yaml @@ -672,7 +672,7 @@ components: $ref: "#/components/schemas/ConfigResponse" id: type: string - description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as `subscriptionId` as per [Commonalities Event Notification Model](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#122-event-notification). + description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as subscriptionId as per Commonalities Event Notification Model. example: "1119920371" startsAt: type: string @@ -724,7 +724,7 @@ components: SubscriptionId: type: string - description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as `subscriptionId` as per [Commonalities Event Notification Model](https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#122-event-notification). + description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as subscriptionId as per Commonalities Event Notification Model. example: qs15-h556-rt89-1298 Device: From c500b477bd6883bb5ccb90f1a745569e4758ba3c Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 15 Sep 2025 11:25:21 +0200 Subject: [PATCH 12/12] Update location-verification.feature --- code/Test_definitions/location-verification.feature | 2 -- 1 file changed, 2 deletions(-) diff --git a/code/Test_definitions/location-verification.feature b/code/Test_definitions/location-verification.feature index 91bb6e7b..5c260bf4 100644 --- a/code/Test_definitions/location-verification.feature +++ b/code/Test_definitions/location-verification.feature @@ -310,6 +310,4 @@ Feature: CAMARA Device location verification API, v3.0.0 - Operation verifyLocat Then the response status code is 422 And the response property "$.status" is 422 And the response property "$.code" is "LOCATION_VERIFICATION.UNABLE_TO_LOCATE" - And the response property "$.message" contains a user-friendly text -