From 787faebbe0527dc0d0fd9b3ce5b9188ecc8c3740 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Mon, 26 Aug 2024 14:41:42 +0200 Subject: [PATCH 01/10] Release PR for public release r1.2 (M4) --- CHANGELOG.md | 25 ++++++++++--------- README.md | 9 +++---- .../geofencing-subscriptions.yaml | 4 +-- code/API_definitions/location-retrieval.yaml | 4 +-- .../location-verification.yaml | 4 +-- ...g-subscriptions-API-Readiness-Checklist.md | 12 ++++----- ...ation-retrieval-API-Readiness-Checklist.md | 12 ++++----- ...on-verification-API-Readiness-Checklist.md | 10 ++++---- 8 files changed, 40 insertions(+), 40 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d37fc26..7334dff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## Table of Contents -- [r1.1](#r11) +- **[r1.2](#r12)** - [v0.2.0](#v020) - [v0.1.0](#v010) @@ -14,22 +14,22 @@ The below sections record the changes for each API version in each release as fo * 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 -# r1.1 +# r1.2 ## 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 +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-rc.1 -* Identity and Consent Management v0.2.0-rc.1 +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 -**Full Changelog** with the list of PRs and contributors: https://github.com/camaraproject/DeviceLocation/compare/v0.2.0...r1.1 +**Full Changelog** with the list of PRs and contributors: https://github.com/camaraproject/DeviceLocation/compare/v0.2.0...r1.2 -## location-verification v1.0.0-rc.1 +## location-verification v1.0.0 ### Added @@ -48,7 +48,7 @@ The API definition(s) are based on * Update the PARTIAL case description: `match_rate` is set in the response -## location-retrieval v0.3.0-rc.1 +## location-retrieval v0.3.0 ### Added @@ -67,7 +67,7 @@ The API definition(s) are based on * Clarify that `lastLocationTime` is mandatory in responses -## geofencing-subscriptions v0.3.0-rc.1 +## geofencing-subscriptions v0.3.0 ### Added @@ -84,6 +84,7 @@ The API definition(s) are based on * Make '+' mandatory for phoneNumber * Alignment of errors with Commonalities + # v0.2.0 **This is the second alpha version of the DeviceLocation API family.** diff --git a/README.md b/README.md index abf5118..bbc6341 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,10 @@ Repository to describe, develop, document and test the DeviceLocation API family * 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 pre-release is [r1.1](https://github.com/camaraproject/DeviceLocation/tree/r1.1) -The release r1.1 contains the following API definitions (with inline documentation): - - **location-verification v1.0.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r1.1/code/API_definitions/location-verification.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/location-verification.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/location-verification.yaml) - - **location-retrieval v0.3.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r1.1/code/API_definitions/location-retrieval.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/location-retrieval.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/location-retrieval.yaml) - - **geofencing-subscriptions v0.3.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r1.1/code/API_definitions/geofencing.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/geofencing.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.1/code/API_definitions/geofencing.yaml) +* The latest pre-release is [r1.2](https://github.com/camaraproject/DeviceLocation/tree/r1.2) with the following API definitions (with inline documentation): + - **location-verification v1.0.0** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r1.2/code/API_definitions/location-verification.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.2/code/API_definitions/location-verification.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.2/code/API_definitions/location-verification.yaml) + - **location-retrieval v0.3.0** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r1.2/code/API_definitions/location-retrieval.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.2/code/API_definitions/location-retrieval.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.2/code/API_definitions/location-retrieval.yaml) + - **geofencing-subscriptions v0.3.0** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r1.2/code/API_definitions/geofencing.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.2/code/API_definitions/geofencing.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.2/code/API_definitions/geofencing.yaml) ## Contributing diff --git a/code/API_definitions/geofencing-subscriptions.yaml b/code/API_definitions/geofencing-subscriptions.yaml index 6e92bd9..b67781b 100644 --- a/code/API_definitions/geofencing-subscriptions.yaml +++ b/code/API_definitions/geofencing-subscriptions.yaml @@ -72,7 +72,7 @@ info: (FAQs will be added in a later version of the documentation) - version: 0.3.0-rc.1 + version: 0.3.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -82,7 +82,7 @@ externalDocs: url: https://github.com/camaraproject/DeviceLocation servers: - - url: "{apiRoot}/geofencing-subscriptions/v0.3rc1" + - url: "{apiRoot}/geofencing-subscriptions/v0.3" variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index 557f836..741a3c5 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -87,7 +87,7 @@ info: # Further info and support (FAQs will be added in a later version of the documentation) - version: 0.3.0-rc.1 + version: 0.3.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -96,7 +96,7 @@ externalDocs: description: Project documentation at Camara url: https://github.com/camaraproject/DeviceLocation servers: - - url: '{apiRoot}/location-retrieval/v0.3rc1' + - url: '{apiRoot}/location-retrieval/v0.3' variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/location-verification.yaml b/code/API_definitions/location-verification.yaml index 18eeb8a..2c6dd3c 100644 --- a/code/API_definitions/location-verification.yaml +++ b/code/API_definitions/location-verification.yaml @@ -80,7 +80,7 @@ info: # Further info and support (FAQs will be added in a later version of the documentation) - version: 1.0.0-rc.1 + version: 1.0.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -89,7 +89,7 @@ externalDocs: description: Project documentation at CAMARA url: https://github.com/camaraproject/DeviceLocation servers: - - url: "{apiRoot}/location-verification/v1rc1" + - url: "{apiRoot}/location-verification/v1" variables: apiRoot: default: http://localhost:9091 diff --git a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md index 3039486..b02037a 100644 --- a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md @@ -4,18 +4,18 @@ Checklist for geofencing-subscriptions 0.3.0-rc.1 in r1.1 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------------------------:|:-------------------------:|:------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------:| -| 1 | API definition | M | M | M | M | Y | /code/API_definitions/geofencing-subscriptions.yaml | +| 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 | | | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | 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 | NA | link | +| 6 | User stories | O | O | O | M | N | | | 7 | Basic API test cases & documentation | O | M | M | M | tbd | PR: /pull/181 | -| 8 | Enhanced API test cases & documentation | O | O | O | M | NA | link | -| 9 | Test result statement | O | O | O | M | NA | link | +| 8 | Enhanced API test cases & documentation | O | O | O | M | N | | +| 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 | -| 12 | Previous public-release was certified | O | O | O | M | NA | | +| 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) | +| 12 | Previous public-release was certified | O | O | O | M | N | | Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index e78c6c9..1706e72 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -4,18 +4,18 @@ Checklist for location-retrieval 0.3.0-rc.1 in r1.1 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M | Y | /code/API_definitions/location-retrieval.yaml | +| 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 | | | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | 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 | NA | link | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | /code/Test_definitions/location-retrieval.feature | -| 8 | Enhanced API test cases & documentation | O | O | O | M | NA | link | -| 9 | Test result statement | O | O | O | M | NA | link | +| 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 | N | | +| 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 | -| 12 | Previous public-release was certified | O | O | O | M | NA | | +| 12 | Previous public-release was certified | O | O | O | M | N | | Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. diff --git a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md index f5ec205..1bfc2ff 100644 --- a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md @@ -4,17 +4,17 @@ Checklist for location-verification v1.0.0-rc.1 in r1.1. | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M |Y| /code/API_definitions/location-verification.yaml | +| 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| | | 3 | Guidelines from ICM applied | O | M | M | M |Y| | | 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 |tbd| PR: /pull/227 | -| 7 | Basic API test cases & documentation | O | M | M | M |Y| /code/Test_definitions/location-verification.feature | -| 8 | Enhanced API test cases & documentation | O | O | O | M |Y| /code/Test_definitions/location-verification.feature | +| 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 |tbd| link | | 10 | API release numbering convention applied | M | M | M | M |Y| | -| 11 | Change log updated | M | M | M | M |Y| /CHANGELOG.md | +| 11 | Change log updated | M | M | M | M |Y| [/CHANGELOG.md](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M |Y| | Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. From d519fa4ad6cd8e0dd2b3fc43a1ffb13fd2dd9fe8 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Tue, 27 Aug 2024 15:54:35 +0200 Subject: [PATCH 02/10] Update CHANGELOG.md --- CHANGELOG.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 75 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7334dff..1252dec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## Table of Contents - **[r1.2](#r12)** +- [r1.1](#r11) - [v0.2.0](#v020) - [v0.1.0](#v010) @@ -27,7 +28,9 @@ The API definition(s) are based on * Commonalities v0.4.0 * Identity and Consent Management v0.2.0 -**Full Changelog** with the list of PRs and contributors: https://github.com/camaraproject/DeviceLocation/compare/v0.2.0...r1.2 +**Changelog since v0.2.0** + +* Full Changelog with the list of PRs and contributors: https://github.com/camaraproject/DeviceLocation/compare/v0.2.0...r1.2 ## location-verification v1.0.0 @@ -84,6 +87,77 @@ The API definition(s) are based on * Make '+' mandatory for phoneNumber * Alignment of errors with Commonalities +# r1.1 + +## Release Notes + +This **pre-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 + +**Changelog since v0.2.0** + +* Full Changelog with the list of PRs and contributors: https://github.com/camaraproject/DeviceLocation/compare/v0.2.0...r1.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 # v0.2.0 From 3392a47bfdfd7db7029f5ecc3a2bdccccca5a083 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Wed, 28 Aug 2024 13:33:00 +0200 Subject: [PATCH 03/10] Update versions in test plan --- code/Test_definitions/Location-Retrieval.feature | 4 ++-- code/Test_definitions/location-verification.feature | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/code/Test_definitions/Location-Retrieval.feature b/code/Test_definitions/Location-Retrieval.feature index 551ec6d..1d275b9 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, v0.3-rc.1 - Operation retrieveLocation +Feature: CAMARA Device location retrieval API, v0.3 - Operation retrieveLocation # Input to be provided by the implementation to the tester # # Implementation indications: @@ -12,7 +12,7 @@ Feature: CAMARA Device location retrieval API, v0.3-rc.1 - Operation retrieveLo # References to OAS spec schemas refer to schemas specifies in location-retrieval.yaml, version 0.2.0 Background: Common retrieveLocation setup - Given the resource "/location-retrieval/v0.3rc1/retrieve" | + Given the resource "/location-retrieval/v0.3/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" is set to a UUID value diff --git a/code/Test_definitions/location-verification.feature b/code/Test_definitions/location-verification.feature index dee2622..8d4ff3f 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, v1.0-rc1 - Operation verifyLocation +Feature: CAMARA Device location verification API, v1.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, v1.0-rc1 - Operation verifyLoc # References to OAS spec schemas refer to schemas specifies in location-verification.yaml, version 0.2.0 Background: Common verifyLocation setup - Given the resource "/location-verification/v1rc1/verify" | + Given the resource "/location-verification/v1/verify" | And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token From 032d6d580c7d25a70aa01887f1b33eb116af44c9 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Wed, 28 Aug 2024 13:40:46 +0200 Subject: [PATCH 04/10] Update changelog with last changes in Geofencing * Add `SUBSCRIPTION_DELETED` and `SUBSCRIPTION_UNPROCESSABLE` as termination reasons * Add `terminationsDescription` as optional event property --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1252dec..8e15995 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -76,7 +76,8 @@ The API definition(s) are based on * Adopt Commonalities guidelines for subscriptions (based on CloudEvents) * Add `subscriptionMaxEvents` for maximum number of notifications -* Add `SUBSCRIPTION_DELETED` as termination-reason +* 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 From a3701135653bcdec18541ad7960ec53a053c1d6d Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 12:41:35 +0200 Subject: [PATCH 05/10] Update and rename Location-Retrieval.feature to location-retrieval.feature --- .../{Location-Retrieval.feature => location-retrieval.feature} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename code/Test_definitions/{Location-Retrieval.feature => location-retrieval.feature} (100%) diff --git a/code/Test_definitions/Location-Retrieval.feature b/code/Test_definitions/location-retrieval.feature similarity index 100% rename from code/Test_definitions/Location-Retrieval.feature rename to code/Test_definitions/location-retrieval.feature From 647ad534b77969b7bbbba5b9f8beeff46c894137 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Fri, 30 Aug 2024 11:32:14 +0200 Subject: [PATCH 06/10] Fixes - Renamed file to geofencing-subscriptions.feature - Updated versions in API-Readiness-Checklist --- .../{Geofencing.feature => geofencing-subscriptions.feature} | 0 .../geofencing-subscriptions-API-Readiness-Checklist.md | 4 ++-- .../location-retrieval-API-Readiness-Checklist.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) rename code/Test_definitions/{Geofencing.feature => geofencing-subscriptions.feature} (100%) diff --git a/code/Test_definitions/Geofencing.feature b/code/Test_definitions/geofencing-subscriptions.feature similarity index 100% rename from code/Test_definitions/Geofencing.feature rename to code/Test_definitions/geofencing-subscriptions.feature diff --git a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md index b02037a..7101ef6 100644 --- a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for geofencing-subscriptions 0.3.0-rc.1 in r1.1 +Checklist for geofencing-subscriptions 0.3.0 in r1.2 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------------------------:|:-------------------------:|:------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------:| @@ -10,7 +10,7 @@ Checklist for geofencing-subscriptions 0.3.0-rc.1 in r1.1 | 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 | tbd | PR: /pull/181 | +| 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 | N | | | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index 1706e72..2215ecf 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for location-retrieval 0.3.0-rc.1 in r1.1 +Checklist for location-retrieval 0.3.0 in r1.2 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From 74fa696ccd3169df155b171e1f7396f7c0cfb2ad Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Fri, 30 Aug 2024 11:37:39 +0200 Subject: [PATCH 07/10] Update location-verification-API-Readiness-Checklist.md --- .../location-verification-API-Readiness-Checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md index 52e0912..20ade5d 100644 --- a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for location-verification v1.0.0-rc.1 in r1.1. +Checklist for location-verification v1.0.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| @@ -12,7 +12,7 @@ Checklist for location-verification v1.0.0-rc.1 in r1.1. | 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 |tbd| link | +| 9 | Test result statement | O | O | O | M |N| camaraproject/ReleaseManagement/issues/89 | | 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 d9322c2d1615c51cf89f841a68d64dde7802a368 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Fri, 6 Sep 2024 11:05:18 +0200 Subject: [PATCH 08/10] Update location-verification-API-Readiness-Checklist.md Aligned with https://github.com/camaraproject/ReleaseManagement/issues/89 --- .../location-verification-API-Readiness-Checklist.md | 4 +++- 1 file changed, 3 insertions(+), 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 20ade5d..3b7237b 100644 --- a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md @@ -12,11 +12,13 @@ Checklist for location-verification v1.0.0 in r1.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 |N| camaraproject/ReleaseManagement/issues/89 | +| 9 | Test result statement | O | O | O | M |N| Fall24 EXCEPTION: Test results not available (*) | | 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| | +(*) If you encounter issues with the provided test files (.feature), please create an issue in the API Sub-Project to signal these issues so they can be fixed in a patch release. + Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist). From 8e4532d1582fabadfdc589d61f0106f173044000 Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Tue, 10 Sep 2024 16:10:33 +0200 Subject: [PATCH 09/10] Changes in descriptions and coments --- code/API_definitions/geofencing-subscriptions.yaml | 4 ++-- code/API_definitions/location-retrieval.yaml | 6 +++--- code/API_definitions/location-verification.yaml | 6 +++--- code/Test_definitions/location-retrieval.feature | 2 +- code/Test_definitions/location-verification.feature | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/code/API_definitions/geofencing-subscriptions.yaml b/code/API_definitions/geofencing-subscriptions.yaml index ccd2239..3e1ebeb 100644 --- a/code/API_definitions/geofencing-subscriptions.yaml +++ b/code/API_definitions/geofencing-subscriptions.yaml @@ -6,7 +6,7 @@ info: # Introduction - With this API, customers can create subscriptions for their devices to receive notifications when a device enters or exits a specified area. + With this API, API consumers can create subscriptions for their devices to receive notifications when a device enters or exits a specified area. The area provided in the request is described by a circle determined by coordinates (latitude and longitude) and an accuracy defined by the radius. @@ -65,7 +65,7 @@ info: The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile. - Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. + Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the API Provider, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index 741a3c5..a1e09e1 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -6,12 +6,12 @@ info: # Introduction - With this API, customers can retrieve the area where a certain user device is localized. + With this API, API consumers can retrieve the area where a certain user device is localized. The area provided in the response could be described: - by a circle determined by coordinates (latitude and longitude) and a radius. - by a simple polygon delimited by segments connecting consecutively an array of coordinates (points). The last point connects to the first point to delimit a closed shape bounded with straight sides. - The retrieved shape depends on the network conditions at the subscriber's location and any of the supported shapes could be received. + The retrieved shape depends on the network conditions at the device's location and any of the supported shapes could be received. The requester could optionally ask for a freshness of the localization information by providing a `maxAge` ("I want a location not older than 600 seconds"). @@ -56,7 +56,7 @@ info: The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile. - Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. + Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the API Provider, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. diff --git a/code/API_definitions/location-verification.yaml b/code/API_definitions/location-verification.yaml index 2c6dd3c..f988198 100644 --- a/code/API_definitions/location-verification.yaml +++ b/code/API_definitions/location-verification.yaml @@ -2,11 +2,11 @@ openapi: 3.0.3 info: title: Device Location Verification description: | - This API provides the customer with the ability to verify the location of a device. + This API provides the consumer with the ability to verify the location of a device. # Introduction - Customers are able to verify whether the location of certain user device is within the area specified. Currently the only area supported as input is a circle determined by a set of coordinates (latitude and longitude) and some expected accuracy (radius). + API consumers are able to verify whether the location of certain user device is within the area specified. Currently the only area supported as input is a circle determined by a set of coordinates (latitude and longitude) and some expected accuracy (radius). The verification result depends on the network's ability and accuracy to locate the device at the requested area. @@ -49,7 +49,7 @@ info: The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile. - Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. + Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the API Provider, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation. It is important to remark that in cases where personal user data is processed by the API, and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. diff --git a/code/Test_definitions/location-retrieval.feature b/code/Test_definitions/location-retrieval.feature index c9334c3..38d574c 100644 --- a/code/Test_definitions/location-retrieval.feature +++ b/code/Test_definitions/location-retrieval.feature @@ -9,7 +9,7 @@ Feature: CAMARA Device location retrieval API, v0.3 - Operation retrieveLocatio # * 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. # - # References to OAS spec schemas refer to schemas specifies in location-retrieval.yaml, version 0.2.0 + # References to OAS spec schemas refer to schemas specifies in location-retrieval.yaml Background: Common retrieveLocation setup Given the resource "/location-retrieval/v0.3/retrieve" | diff --git a/code/Test_definitions/location-verification.feature b/code/Test_definitions/location-verification.feature index ea7331a..704fe78 100644 --- a/code/Test_definitions/location-verification.feature +++ b/code/Test_definitions/location-verification.feature @@ -9,7 +9,7 @@ Feature: CAMARA Device location verification API, v1.0 - Operation verifyLocatio # * 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 # - # References to OAS spec schemas refer to schemas specifies in location-verification.yaml, version 0.2.0 + # References to OAS spec schemas refer to schemas specifies in location-verification.yaml Background: Common verifyLocation setup Given the resource "/location-verification/v1/verify" | From 3f65e51a42cbab0095bcbefa9353b7754ace699c Mon Sep 17 00:00:00 2001 From: Jose Luis Urien Date: Tue, 10 Sep 2024 16:33:45 +0200 Subject: [PATCH 10/10] full versions in feature title --- code/Test_definitions/location-retrieval.feature | 2 +- code/Test_definitions/location-verification.feature | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/location-retrieval.feature b/code/Test_definitions/location-retrieval.feature index 38d574c..f99d839 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, v0.3 - Operation retrieveLocation +Feature: CAMARA Device location retrieval API, v0.3.0 - Operation retrieveLocation # Input to be provided by the implementation to the tester # # Implementation indications: diff --git a/code/Test_definitions/location-verification.feature b/code/Test_definitions/location-verification.feature index 704fe78..73acd41 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, v1.0 - Operation verifyLocation +Feature: CAMARA Device location verification API, v1.0.0 - Operation verifyLocation # Input to be provided by the implementation to the tester # # Implementation indications: