From 97c685e944a65262f51c41239868b8029cbbf61a Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 11:43:35 +0100 Subject: [PATCH 01/25] release: update specifications with their new version --- code/API_definitions/geofencing-subscriptions.yaml | 4 ++-- code/API_definitions/location-retrieval.yaml | 4 ++-- code/API_definitions/location-verification.yaml | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/code/API_definitions/geofencing-subscriptions.yaml b/code/API_definitions/geofencing-subscriptions.yaml index 305ff41..e381cc9 100644 --- a/code/API_definitions/geofencing-subscriptions.yaml +++ b/code/API_definitions/geofencing-subscriptions.yaml @@ -73,7 +73,7 @@ info: (FAQs will be added in a later version of the documentation) - version: wip + version: 0.4.0-rc.1 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -83,7 +83,7 @@ externalDocs: url: https://github.com/camaraproject/DeviceLocation servers: - - url: "{apiRoot}/geofencing-subscriptions/vwip" + - url: "{apiRoot}/geofencing-subscriptions/v0.4rc1" variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index 7841618..a7188d1 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: wip + version: 0.4.0-rc.1 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/vwip' + - url: '{apiRoot}/location-retrieval/v0.4rc1' variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/location-verification.yaml b/code/API_definitions/location-verification.yaml index 7ca443c..2c39577 100644 --- a/code/API_definitions/location-verification.yaml +++ b/code/API_definitions/location-verification.yaml @@ -70,7 +70,7 @@ info: # Further info and support (FAQs will be added in a later version of the documentation) - version: wip + version: 2.0.0-rc.1 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -79,7 +79,7 @@ externalDocs: description: Project documentation at CAMARA url: https://github.com/camaraproject/DeviceLocation servers: - - url: "{apiRoot}/location-verification/vwip" + - url: "{apiRoot}/location-verification/v2rc1" variables: apiRoot: default: http://localhost:9091 From 92f561e02f9202655eb195db44d5b2699a48e40f Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 11:43:48 +0100 Subject: [PATCH 02/25] feat: delete not needed README.MD --- documentation/API_documentation/README.MD | 1 - 1 file changed, 1 deletion(-) delete mode 100644 documentation/API_documentation/README.MD diff --git a/documentation/API_documentation/README.MD b/documentation/API_documentation/README.MD deleted file mode 100644 index 37aa0ff..0000000 --- a/documentation/API_documentation/README.MD +++ /dev/null @@ -1 +0,0 @@ -This README.MD can be deleted when the first file is added to this directory. From ec0c7341d6ea626df87f0f4af53c17a8144fe86d Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 11:44:06 +0100 Subject: [PATCH 03/25] release: update feature-files for new version --- code/Test_definitions/geofencing-subscriptions.feature | 6 +++--- code/Test_definitions/location-retrieval.feature | 4 ++-- code/Test_definitions/location-verification.feature | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/code/Test_definitions/geofencing-subscriptions.feature b/code/Test_definitions/geofencing-subscriptions.feature index 6626f93..bc66df4 100644 --- a/code/Test_definitions/geofencing-subscriptions.feature +++ b/code/Test_definitions/geofencing-subscriptions.feature @@ -1,11 +1,11 @@ @Geofencing -Feature: Camara Geofencing Subscriptions API, v0.3.0 - Operations on subscriptions +Feature: Camara Geofencing Subscriptions API, v0.4.0-rc.1 - Operations on subscriptions # Input to be provided by the implementation to the tests -# References to OAS spec schemas refer to schemas specified in geofencing-subscriptions.yaml, version v0.3.0 +# References to OAS spec schemas refer to schemas specified in geofencing-subscriptions.yaml, version v0.4.0-rc.1 Background: Common Geofencing Subscriptions setup - Given the resource "{apiroot}/geofencing-subscriptions/v0.3/" as geofencing base-url + Given the resource "{apiroot}/geofencing-subscriptions/v0.4rc1/" as geofencing base-url 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-retrieval.feature b/code/Test_definitions/location-retrieval.feature index 5d3b184..a5145ff 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.4.0-rc.1 - 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.4rc1/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 949c537..642b54b 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, v2.0.0-rc.1 - 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/v2rc1/verify" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token From 5d40c61d4c21ceac546ccd3d526de6a595d1b963 Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 11:44:22 +0100 Subject: [PATCH 04/25] release: update geofencing-subscriptions-API-Readiness-Checklist.md --- ...g-subscriptions-API-Readiness-Checklist.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md index 7101ef6..10087fc 100644 --- a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md @@ -1,21 +1,21 @@ # API Readiness Checklist -Checklist for geofencing-subscriptions 0.3.0 in r1.2 +Checklist for geofencing-subscriptions 0.4.0-rc.1 in r2.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](/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 | 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 | 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](/CHANGELOG.md) | -| 12 | Previous public-release was certified | O | O | O | M | N | | +| 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](/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 | 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 | 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](/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. From ef570611035c881a47db9b87a60f5689551834ae Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 11:44:54 +0100 Subject: [PATCH 05/25] release: update location-retrieval-API-Readiness-Checklist.md --- ...ation-retrieval-API-Readiness-Checklist.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index 2215ecf..e2c1fcf 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -1,21 +1,21 @@ # API Readiness Checklist -Checklist for location-retrieval 0.3.0 in r1.2 +Checklist for location-retrieval 0.4.0-rc.1 in r2.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](/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 | 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 | N | | +| 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](/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 | 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](/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. From 724f5cf5189d201f5b424619cc12af693f8d0fb1 Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 11:52:59 +0100 Subject: [PATCH 06/25] release: update location-verification-API-Readiness-Checklist.md and location-verification-User-Story.md --- ...on-verification-API-Readiness-Checklist.md | 28 +++++++++---------- .../location-verification-User-Story.md | 16 +++++------ 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md index 3b7237b..2432626 100644 --- a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md @@ -2,20 +2,20 @@ Checklist for location-verification v1.0.0 in r1.2 -| 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](/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 | 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| 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| | +| 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](/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 | 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 | 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. diff --git a/documentation/API_documentation/location-verification-User-Story.md b/documentation/API_documentation/location-verification-User-Story.md index 4242963..e785cf8 100644 --- a/documentation/API_documentation/location-verification-User-Story.md +++ b/documentation/API_documentation/location-verification-User-Story.md @@ -1,11 +1,11 @@ # Location Verification API User Story -| **Item** | **Details** | -| ---- | ------- | -| ***Summary*** | As an enterprise application developer, I want to verify the location of a user's device, so that I can ensure the device is within a specified area for security and contextual-based services. | -| ***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP).
**Scope:**
- Verifies if the specified device is located within a predefined geographical area (e.g.circle with given coordinates and radius, polygon...). | -| ***Pre-conditions*** |The preconditions are listed below:
  1. The ASP:BusinessManager and ASP:Administrator have been onboarded to the CSP's API platform.
  2. The ASP:BusinessManager has successfully subscribed to the Location Verification API product from the product catalog via (or not) a Channel Partner.
  3. The ASP:Administrator has onboarded the ASP:User to the platform.
  4. The ASP:User performs an authorization request to CSP
  5. The CSP checks access & End-User approval then provide access token to the ASP:User
  6. The ASP:User get the access token, via (or not) the Channel Partner, allowing a secure access of the API. -| ***Activities/Steps*** | **Starts when:** The ASP:User makes a POST request via the Location Verification API providing the End-User's device identifier (e.g., phone number), the area information (center coordinates and radius, polygon...) and the maximum age of the location information.
    **Ends when:** The CSP's Location Verification server responds with the verification result indicating if the End-User's device is within the specified area, partially matches the area, or is unknown. | -| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the End-User's device location. | -| ***Exceptions*** | Several exceptions might occur during the Location Verification API operations
    - Unauthorized: Invalid credentials (e.g., expired access token).
    - Incorrect input data (e.g., malformed phone number).
    - Not able to provide: Network unable to locate the device due to various reasons (e.g., device not connected, outdated location data). | +| **Item** | **Details** | +|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ***Summary*** | As an enterprise application developer, I want to verify the location of a user's device, so that I can ensure the device is within a specified area for security and contextual-based services. | +| ***Actors and Scope*** | **Actors:** Application service provider (ASP), ASP:User, ASP: BusinessManager, ASP:Administrator, Channel Partner, End-User, Communication Service Provider (CSP).
    **Scope:**
    - Verifies if the specified device is located within a predefined geographical area (e.g.circle with given coordinates and radius, polygon...). | +| ***Pre-conditions*** | The preconditions are listed below:
    1. The ASP:BusinessManager and ASP:Administrator have been onboarded to the CSP's API platform.
    2. The ASP:BusinessManager has successfully subscribed to the Location Verification API product from the product catalog via (or not) a Channel Partner.
    3. The ASP:Administrator has onboarded the ASP:User to the platform.
    4. The ASP:User performs an authorization request to CSP
    5. The CSP checks access & End-User approval then provide access token to the ASP:User
    6. The ASP:User get the access token, via (or not) the Channel Partner, allowing a secure access of the API. | +| ***Activities/Steps*** | **Starts when:** The ASP:User makes a POST request via the Location Verification API providing the End-User's device identifier (e.g., phone number), the area information (center coordinates and radius, polygon...) and the maximum age of the location information.
      **Ends when:** The CSP's Location Verification server responds with the verification result indicating if the End-User's device is within the specified area, partially matches the area, or is unknown. When the device partially matches the area, the server additionally responds with a match-rate, which defines a percent value of the intersection of both areas. | +| ***Post-conditions*** | The ASP:User could continue offering its service to the End-User with the confirmation of the End-User's device location. | +| ***Exceptions*** | Several exceptions might occur during the Location Verification API operations
      - Unauthorized: Invalid credentials (e.g., expired access token).
      - Incorrect input data (e.g., malformed phone number).
      - Not able to provide: Network unable to locate the device due to various reasons (e.g., device not connected, outdated location data). | From 4290cf5e906db4aaa852ce872867c02ca2a157c1 Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 11:53:17 +0100 Subject: [PATCH 07/25] fix: correct changes on location-retrieval-API-Readiness-Checklist.md and geofencing-subscriptions-API-Readiness-Checklist.md --- .../geofencing-subscriptions-API-Readiness-Checklist.md | 6 ++++-- .../location-retrieval-API-Readiness-Checklist.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md index 10087fc..4536014 100644 --- a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md @@ -11,12 +11,14 @@ Checklist for geofencing-subscriptions 0.4.0-rc.1 in r2.1 | 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 | N | | -| 9 | Test result statement | 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) | +| 9 | Test result statement | O | O | O | M | N | 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 | N | | +(*) 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). diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index e2c1fcf..eaa31c5 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -11,12 +11,14 @@ Checklist for location-retrieval 0.4.0-rc.1 in r2.1 | 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 | N | | -| 9 | Test result statement | 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) | +| 9 | Test result statement | O | O | O | M | N | 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 | N | | +(*) 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). \ No newline at end of file From 8f0bcd0064b8713875dd1ee81430e2bcb59b908d Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 13:17:38 +0100 Subject: [PATCH 08/25] release: update CHANGELOG.md for r2.1 --- CHANGELOG.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 66 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8e15995..00cbaf3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,8 @@ ## Table of Contents -- **[r1.2](#r12)** +- **[r2.1](#r21)** +- [r1.2](#r12) - [r1.1](#r11) - [v0.2.0](#v020) - [v0.1.0](#v010) @@ -15,6 +16,70 @@ 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 +# r2.1 + +## Release Notes + +This **public release** contains the definition and documentation of +* location-verification v2.0.0-rc.1 +* location-retrieval v0.4.0-rc.1 +* geofencing-subscriptions v0.4.0-rc.1 + +The API definition(s) are based on +* Commonalities v0.5.0 +* Identity and Consent Management v0.2.1 + +**Changelog since v0.2.0** + +* Full Changelog with the list of PRs and contributors: https://github.com/camaraproject/DeviceLocation/compare/r1.2...r2.1 + +## location-verification v2.0.0-rc.1 + +### Changed + +* Error schemas updated with enums +* Some error status and codes have been updated +* Section with guidelines about how to identify the device from access token and request body has been updated + +### Fixed +* Update errormessage for unsupported device identifiers +* Add quote-marks for `lastLocationTime` - examples + +## location-retrieval v0.4.0-rc.1 + +### Added + +* Add management of `maxSurface` in request. + +### Changed + +* Error schemas updated with enums +* Some error status and codes have been updated +* Section with guidelines about how to identify the device from access token and request body has been updated +* Test definitions aligned with API specification update + +### Fixed + +* Update errormessage for unsupported device identifiers +* Add quote-marks for `lastLocationTime` - examples + +## geofencing-subscriptions v0.4.0-rc.1 + +### Added + +* Add test-definitions for HTTP-422 error-cases for geofencing-API + +### Changed + +* Error schemas updated with enums +* Some error status and codes have been updated +* Add a note that initial events will be counted when `subscriptionMaxEvents` is combined with initialEvent=true + +### Fixed +* remove `allOf` in `sinkCredential` +* Correct the example for subscriptions regarding `initialEvent` and error `MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED` +* Add quote-marks for `subscriptionExpireTime` - examples + # r1.2 ## Release Notes From c969f566bc962fbc57ab5df0f8901e2eb0ab9e34 Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 13:46:22 +0100 Subject: [PATCH 09/25] release: update CHANGELOG.md for r2.1 --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 00cbaf3..f10f9d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -37,6 +37,7 @@ The API definition(s) are based on ### Changed +* Decrease radius minimum to "1" for circle-area * Error schemas updated with enums * Some error status and codes have been updated * Section with guidelines about how to identify the device from access token and request body has been updated @@ -71,6 +72,7 @@ The API definition(s) are based on ### Changed +* Decrease radius minimum to "1" for circle-area * Error schemas updated with enums * Some error status and codes have been updated * Add a note that initial events will be counted when `subscriptionMaxEvents` is combined with initialEvent=true From 7d49e71057a63f37d5616e2b00e26391098c7fdb Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 14:26:01 +0100 Subject: [PATCH 10/25] release: add pull-request references to CHANGELOG.md --- CHANGELOG.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f10f9d7..c6308c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -37,50 +37,50 @@ The API definition(s) are based on ### Changed -* Decrease radius minimum to "1" for circle-area -* Error schemas updated with enums -* Some error status and codes have been updated -* Section with guidelines about how to identify the device from access token and request body has been updated +* Decrease radius minimum to "1" for circle-area by @maxl2287 in #285 +* Error schemas updated with enums by @jlurien in #281 +* Some error status and codes have been updated by @jlurien in #281 +* Section with guidelines about how to identify the device from access token and request body has been updated by @jlurien in #281 ### Fixed -* Update errormessage for unsupported device identifiers -* Add quote-marks for `lastLocationTime` - examples +* Update errormessage for unsupported device identifiers by @maxl2287 in #261 +* Add quote-marks for `lastLocationTime` - examples by @maxl2287 in #287 ## location-retrieval v0.4.0-rc.1 ### Added -* Add management of `maxSurface` in request. +* Add management of `maxSurface` in request by @bigludo7 in #262 ### Changed -* Error schemas updated with enums -* Some error status and codes have been updated -* Section with guidelines about how to identify the device from access token and request body has been updated -* Test definitions aligned with API specification update +* Error schemas updated with enums by @bigludo7 in #283 +* Some error status and codes have been updated by @bigludo7 in #283 +* Section with guidelines about how to identify the device from access token and request body has been updated by @bigludo7 in #283 +* Test definitions aligned with API specification update by @bigludo7 in #283 ### Fixed -* Update errormessage for unsupported device identifiers -* Add quote-marks for `lastLocationTime` - examples +* Update errormessage for unsupported device identifiers by @maxl2287 in #261 +* Add quote-marks for `lastLocationTime` - examples by @maxl2287 in #287 ## geofencing-subscriptions v0.4.0-rc.1 ### Added -* Add test-definitions for HTTP-422 error-cases for geofencing-API +* Add test-definitions for HTTP-422 error-cases for geofencing-API by @maxl2287 in #289 ### Changed -* Decrease radius minimum to "1" for circle-area -* Error schemas updated with enums -* Some error status and codes have been updated -* Add a note that initial events will be counted when `subscriptionMaxEvents` is combined with initialEvent=true +* Decrease radius minimum to "1" for circle-area by @maxl2287 in #285 +* Error schemas updated with enums by @maxl2287 in #284 +* Some error status and codes have been updated by @maxl2287 in #284 +* Add a note that initial events will be counted when `subscriptionMaxEvents` is combined with initialEvent=true by @maxl2287 in #284 ### Fixed -* remove `allOf` in `sinkCredential` -* Correct the example for subscriptions regarding `initialEvent` and error `MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED` -* Add quote-marks for `subscriptionExpireTime` - examples +* remove `allOf` in `sinkCredential` by @maxl2287 in #265 +* Correct the example for subscriptions regarding `initialEvent` and error `MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED` by @dfischer-tech in #267 +* Add quote-marks for `subscriptionExpireTime` - examples by @maxl2287 in #287 # r1.2 From 5b1f5c874ef46fa012d9d8df5f614331ca49fd4e Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 22:31:04 +0100 Subject: [PATCH 11/25] release: update CHANGELOG.md based on latest MultiSim info.discription --- CHANGELOG.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c6308c0..30e95cf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,6 +35,10 @@ The API definition(s) are based on ## location-verification v2.0.0-rc.1 +### Added + +* Add MultiSIM section to info.description by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/291 + ### Changed * Decrease radius minimum to "1" for circle-area by @maxl2287 in #285 @@ -51,6 +55,7 @@ The API definition(s) are based on ### Added * Add management of `maxSurface` in request by @bigludo7 in #262 +* Add MultiSIM section to info.description by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/291 ### Changed @@ -69,6 +74,8 @@ The API definition(s) are based on ### Added * Add test-definitions for HTTP-422 error-cases for geofencing-API by @maxl2287 in #289 +* Add MultiSIM section to info.description by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/291 + ### Changed From 4472dc81df62d313592f66a0337f72ba4edd9c3f Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Thu, 23 Jan 2025 23:03:28 +0100 Subject: [PATCH 12/25] fix: update version in 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 2432626..922d034 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 in r1.2 +Checklist for location-verification 2.0.0-rc.1 in r2.1 | Nr | API release assets | alpha | release-candidate | initial
      public | stable
      public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-----------------:|:-----------------:|:------:|:--------------------------------------------------------------------------------------------------------------------------------------------:| From 94ebe8a30933fbb124bcd64eccadf7eb7a1d702f Mon Sep 17 00:00:00 2001 From: Maximilian Laue <112983658+maxl2287@users.noreply.github.com> Date: Thu, 23 Jan 2025 23:05:06 +0100 Subject: [PATCH 13/25] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 30e95cf..3680136 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,7 +29,8 @@ The API definition(s) are based on * Commonalities v0.5.0 * Identity and Consent Management v0.2.1 -**Changelog since v0.2.0** +**Changelog since r1.2** + * Full Changelog with the list of PRs and contributors: https://github.com/camaraproject/DeviceLocation/compare/r1.2...r2.1 From 07ec2b2ffd0cd806b78e32b801ab2665c05d1a95 Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Fri, 24 Jan 2025 11:23:24 +0100 Subject: [PATCH 14/25] fix: correct checklist row (8) for geofencing-subscriptions-API-Readiness-Checklist.md & geofencing-subscriptions-API-Readiness-Checklist.md --- .../geofencing-subscriptions-API-Readiness-Checklist.md | 2 +- .../location-retrieval-API-Readiness-Checklist.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md index 4536014..bd734ad 100644 --- a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md @@ -11,7 +11,7 @@ Checklist for geofencing-subscriptions 0.4.0-rc.1 in r2.1 | 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) | -| 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 (*) | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) | diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index eaa31c5..848dd6e 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -11,7 +11,7 @@ Checklist for location-retrieval 0.4.0-rc.1 in r2.1 | 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) | -| 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 (*) | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [/CHANGELOG.md](/CHANGELOG.md) | From 6cec18ff88bbd7ff9e8c59242a17d08c2ad92e5f Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Fri, 24 Jan 2025 11:43:15 +0100 Subject: [PATCH 15/25] release: updated root README.md with new versions --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cba4ac0..4dc12bf 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,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.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-subscriptions.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.2/code/API_definitions/geofencing-subscriptions.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r1.2/code/API_definitions/geofencing-subscriptions.yaml) +* The latest pre-release is [r2.1](https://github.com/camaraproject/DeviceLocation/tree/r2.1) with the following API definitions (with inline documentation): + - **location-verification v2.0.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.1/code/API_definitions/location-verification.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-verification.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-verification.yaml) + - **location-retrieval v0.4.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.1/code/API_definitions/location-retrieval.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-retrieval.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-retrieval.yaml) + - **geofencing-subscriptions v0.4.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.1/code/API_definitions/geofencing-subscriptions.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/geofencing-subscriptions.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/geofencing-subscriptions.yaml) ## Contributing From a0b79707d71e26fb03fb52d78c7bf0759f8ee57b Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:33:44 +0100 Subject: [PATCH 16/25] Add pattern for x-correlator & fix 429 documentation --- code/API_definitions/location-retrieval.yaml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index e9d5897..f061e04 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -209,11 +209,13 @@ components: description: Correlation id for the different services schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ headers: x-correlator: description: Correlation id for the different services schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ schemas: RetrievalLocationRequest: description: Request to retrieve the location of a device. Device is not required when using a 3-legged access token, following the rules in the description. @@ -639,13 +641,13 @@ components: value: status: 429 code: QUOTA_EXCEEDED - message: Either out of resource quota or reaching rate limiting. + message: Out of resource quota. GENERIC_429_TOO_MANY_REQUESTS: - description: API Server request limit is overpassed + description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached value: status: 429 code: TOO_MANY_REQUESTS - message: Either out of resource quota or reaching rate limiting. + message: Rate limit reached. examples: RETRIEVAL_CIRCLE: summary: circle-based device location retrieval From 9d4425839d7cc23b8cb5d56ac8020a637bbb0270 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:35:17 +0100 Subject: [PATCH 17/25] Add pattern for x-correlator & fix 429 documentation --- code/API_definitions/location-verification.yaml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/code/API_definitions/location-verification.yaml b/code/API_definitions/location-verification.yaml index c4cac01..2205b8c 100644 --- a/code/API_definitions/location-verification.yaml +++ b/code/API_definitions/location-verification.yaml @@ -223,11 +223,13 @@ components: description: Correlation id for the different services schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ headers: x-correlator: description: Correlation id for the different services schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ schemas: Area: description: Base schema for all areas @@ -683,10 +685,10 @@ components: value: status: 429 code: QUOTA_EXCEEDED - message: Either out of resource quota or reaching rate limiting. + message: Out of resource quota. GENERIC_429_TOO_MANY_REQUESTS: - description: API Server request limit is overpassed + description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached value: status: 429 code: TOO_MANY_REQUESTS - message: Either out of resource quota or reaching rate limiting. + message: Rate limit reached. From a32303f6206bcf9eb6ab74d4e890db79de4de28b Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:39:07 +0100 Subject: [PATCH 18/25] Add pattern for x-correlator & fix 429 documentation --- code/API_definitions/geofencing-subscriptions.yaml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/code/API_definitions/geofencing-subscriptions.yaml b/code/API_definitions/geofencing-subscriptions.yaml index ac61706..192c158 100644 --- a/code/API_definitions/geofencing-subscriptions.yaml +++ b/code/API_definitions/geofencing-subscriptions.yaml @@ -323,11 +323,13 @@ components: description: Correlation id for the different services. schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ headers: x-correlator: description: Correlation id for the different services. schema: type: string + pattern: ^[a-zA-Z0-9-]{0,55}$ schemas: ErrorInfo: description: The error info object for possible error cases. @@ -1414,17 +1416,17 @@ components: - TOO_MANY_REQUESTS examples: GENERIC_429_QUOTA_EXCEEDED: - description: Request is rejected due to exceeding a business quota limit. + description: Request is rejected due to exceeding a business quota limit value: status: 429 code: QUOTA_EXCEEDED - message: Either out of resource quota or reaching rate limiting. + message: Out of resource quota. GENERIC_429_TOO_MANY_REQUESTS: - description: API Server request limit is overpassed. + description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached value: status: 429 code: TOO_MANY_REQUESTS - message: Either out of resource quota or reaching rate limiting. + message: Rate limit reached. examples: REQUEST_CIRCLE_AREA_ENTERED: description: A sample geofence for entering for a circle area. From 9d6f70b10f8a60c77b3d2e39a4117f9b8b5a2c7d Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 28 Jan 2025 09:46:12 +0100 Subject: [PATCH 19/25] Add pattern for x-correlator & 429 documentation in changelog --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3680136..1e8e183 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,6 +46,8 @@ The API definition(s) are based on * Error schemas updated with enums by @jlurien in #281 * Some error status and codes have been updated by @jlurien in #281 * Section with guidelines about how to identify the device from access token and request body has been updated by @jlurien in #281 +* Add pattern for x-correlator by @bigludo7 in #290 +* Update 429 error message by @bigludo7 in #290 ### Fixed * Update errormessage for unsupported device identifiers by @maxl2287 in #261 @@ -64,6 +66,8 @@ The API definition(s) are based on * Some error status and codes have been updated by @bigludo7 in #283 * Section with guidelines about how to identify the device from access token and request body has been updated by @bigludo7 in #283 * Test definitions aligned with API specification update by @bigludo7 in #283 +* Add pattern for x-correlator by @bigludo7 in #290 +* Update 429 error message by @bigludo7 in #290 ### Fixed @@ -84,6 +88,8 @@ The API definition(s) are based on * Error schemas updated with enums by @maxl2287 in #284 * Some error status and codes have been updated by @maxl2287 in #284 * Add a note that initial events will be counted when `subscriptionMaxEvents` is combined with initialEvent=true by @maxl2287 in #284 +* Add pattern for x-correlator by @bigludo7 in #290 +* Update 429 error message by @bigludo7 in #290 ### Fixed * remove `allOf` in `sinkCredential` by @maxl2287 in #265 From f8c861fca5bc55009adb79b8e73715d29b4c8b6b Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Mon, 3 Feb 2025 09:28:16 +0100 Subject: [PATCH 20/25] release: update commonalities version in OAS to 0.5 --- code/API_definitions/geofencing-subscriptions.yaml | 2 +- code/API_definitions/location-retrieval.yaml | 2 +- code/API_definitions/location-verification.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/code/API_definitions/geofencing-subscriptions.yaml b/code/API_definitions/geofencing-subscriptions.yaml index 192c158..aa2228c 100644 --- a/code/API_definitions/geofencing-subscriptions.yaml +++ b/code/API_definitions/geofencing-subscriptions.yaml @@ -94,7 +94,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - x-camara-commonalities: 0.5.0 + x-camara-commonalities: 0.5 externalDocs: description: Project documentation at Camara url: https://github.com/camaraproject/DeviceLocation diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index f061e04..6a92fff 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -105,7 +105,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - x-camara-commonalities: 0.5.0 + x-camara-commonalities: 0.5 externalDocs: description: Project documentation at Camara url: https://github.com/camaraproject/DeviceLocation diff --git a/code/API_definitions/location-verification.yaml b/code/API_definitions/location-verification.yaml index 2205b8c..833b370 100644 --- a/code/API_definitions/location-verification.yaml +++ b/code/API_definitions/location-verification.yaml @@ -91,7 +91,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - x-camara-commonalities: 0.5.0 + x-camara-commonalities: 0.5 externalDocs: description: Project documentation at CAMARA url: https://github.com/camaraproject/DeviceLocation From d1b46a5c55a1349ed20e71d7f1a9ff19bca202d3 Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Mon, 3 Feb 2025 09:36:23 +0100 Subject: [PATCH 21/25] release: update release references to commonalities and ICM in Checklist and CHANGELOG.md --- CHANGELOG.md | 4 +-- ...g-subscriptions-API-Readiness-Checklist.md | 6 ++-- ...ation-retrieval-API-Readiness-Checklist.md | 6 ++-- ...on-verification-API-Readiness-Checklist.md | 28 +++++++++---------- 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e8e183..963931c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -106,8 +106,8 @@ This **public release** contains the definition and documentation of * geofencing-subscriptions v0.3.0 The API definition(s) are based on -* Commonalities v0.4.0 -* Identity and Consent Management v0.2.0 +* Commonalities r2.2 +* Identity and Consent Management r2.2 **Changelog since v0.2.0** diff --git a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md index bd734ad..e360c49 100644 --- a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md @@ -2,11 +2,11 @@ Checklist for geofencing-subscriptions 0.4.0-rc.1 in r2.1 -| Nr | API release assets | alpha | release-candidate | public-release
      initial | public-release
      stable | Status | Comments | +| 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 | | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r2.2 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r2.2 | | 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 | | diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index 848dd6e..3c0cb9e 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -2,11 +2,11 @@ Checklist for location-retrieval 0.4.0-rc.1 in r2.1 -| Nr | API release assets | alpha | release-candidate | public-release
      initial | public-release
      stable | Status | Comments | +| 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 | | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r2.2 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r2.2 | | 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 | | diff --git a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md index 922d034..e1c66c7 100644 --- a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md @@ -2,20 +2,20 @@ Checklist for location-verification 2.0.0-rc.1 in r2.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](/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 | 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 | 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 | | +| 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 | r2.2 | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | r2.2 | +| 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 | N | 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. From 8e13f418ce4a34c1067567d7a5fa1fd6bc2a5ed5 Mon Sep 17 00:00:00 2001 From: Maximilian Laue <112983658+maxl2287@users.noreply.github.com> Date: Tue, 4 Feb 2025 14:42:10 +0100 Subject: [PATCH 22/25] Update README.md Co-authored-by: Herbert Damker --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4dc12bf..3d9f065 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,8 @@ Repository to describe, develop, document and test the DeviceLocation API family - **location-verification v2.0.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.1/code/API_definitions/location-verification.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-verification.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-verification.yaml) - **location-retrieval v0.4.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.1/code/API_definitions/location-retrieval.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-retrieval.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-retrieval.yaml) - **geofencing-subscriptions v0.4.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.1/code/API_definitions/geofencing-subscriptions.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/geofencing-subscriptions.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/geofencing-subscriptions.yaml) - +* Previous releases and pre-releases of the repository are available in https://github.com/camaraproject/DeviceLocation/releases +* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceLocation/blob/main/CHANGELOG.md) ## Contributing * Meetings are held virtually From e46b46308049fc7dd01504ce935fa0c5baf5f59f Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Tue, 4 Feb 2025 15:07:15 +0100 Subject: [PATCH 23/25] fix: updated "# Authorization and authentication"-section based on ICM r2.2 --- code/API_definitions/geofencing-subscriptions.yaml | 6 +++--- code/API_definitions/location-retrieval.yaml | 6 +++--- code/API_definitions/location-verification.yaml | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/code/API_definitions/geofencing-subscriptions.yaml b/code/API_definitions/geofencing-subscriptions.yaml index aa2228c..fd3a7d4 100644 --- a/code/API_definitions/geofencing-subscriptions.yaml +++ b/code/API_definitions/geofencing-subscriptions.yaml @@ -66,11 +66,11 @@ info: # Authorization and authentication - 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. + The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity 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 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. + The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst 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. + In cases where personal 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 three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. # Multi-SIM scenario handling diff --git a/code/API_definitions/location-retrieval.yaml b/code/API_definitions/location-retrieval.yaml index 6a92fff..ff455c5 100644 --- a/code/API_definitions/location-retrieval.yaml +++ b/code/API_definitions/location-retrieval.yaml @@ -64,11 +64,11 @@ info: # Authorization and authentication - 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. + The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity 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 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. + The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst 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. + In cases where personal 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 three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. # Identifying the device from the access token diff --git a/code/API_definitions/location-verification.yaml b/code/API_definitions/location-verification.yaml index 833b370..def8601 100644 --- a/code/API_definitions/location-verification.yaml +++ b/code/API_definitions/location-verification.yaml @@ -50,11 +50,11 @@ info: # Authorization and authentication - 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. + The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity 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 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. + The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst 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. + In cases where personal 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 three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. # Identifying the device from the access token From bcf658394c7a0c0e1feb1517a899e5fa9154b181 Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Tue, 4 Feb 2025 15:08:09 +0100 Subject: [PATCH 24/25] fix: suggested changes in CHANGELOG.md and added "Breaking changes"-note --- CHANGELOG.md | 44 ++++++++++++++++++++++++++++---------------- README.md | 2 -- 2 files changed, 28 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 963931c..e2f9a73 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,9 +12,10 @@ The below sections record the changes for each API version in each release as follows: -* for each first alpha or release-candidate API version, all changes since the release of the previous public API version -* for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release -* for a public API version, the consolidated changes since the release of the previous public API version +* 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 # r2.1 @@ -26,8 +27,8 @@ This **public release** contains the definition and documentation of * geofencing-subscriptions v0.4.0-rc.1 The API definition(s) are based on -* Commonalities v0.5.0 -* Identity and Consent Management v0.2.1 +* Commonalities r2.2 +* Identity and Consent Management r2.2 **Changelog since r1.2** @@ -36,16 +37,20 @@ The API definition(s) are based on ## location-verification v2.0.0-rc.1 +**Please be aware that this release contains breaking changes compared to the previous version.** + +### Breaking Changes +* Some error status and codes have been updated by @jlurien in #281 +* Section with guidelines about how to identify the device from access token and request body has been updated by @jlurien in #281 + ### Added -* Add MultiSIM section to info.description by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/291 +* Add MultiSIM section to info.description by @jlurien in #291 ### Changed * Decrease radius minimum to "1" for circle-area by @maxl2287 in #285 * Error schemas updated with enums by @jlurien in #281 -* Some error status and codes have been updated by @jlurien in #281 -* Section with guidelines about how to identify the device from access token and request body has been updated by @jlurien in #281 * Add pattern for x-correlator by @bigludo7 in #290 * Update 429 error message by @bigludo7 in #290 @@ -54,17 +59,21 @@ The API definition(s) are based on * Add quote-marks for `lastLocationTime` - examples by @maxl2287 in #287 ## location-retrieval v0.4.0-rc.1 +**Please be aware that this release contains breaking changes compared to the previous version.** + +### Breaking Changes + +* Some error status and codes have been updated by @bigludo7 in #283 +* Section with guidelines about how to identify the device from access token and request body has been updated by @bigludo7 in #283 ### Added * Add management of `maxSurface` in request by @bigludo7 in #262 -* Add MultiSIM section to info.description by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/291 +* Add MultiSIM section to info.description by @jlurien in #291 ### Changed * Error schemas updated with enums by @bigludo7 in #283 -* Some error status and codes have been updated by @bigludo7 in #283 -* Section with guidelines about how to identify the device from access token and request body has been updated by @bigludo7 in #283 * Test definitions aligned with API specification update by @bigludo7 in #283 * Add pattern for x-correlator by @bigludo7 in #290 * Update 429 error message by @bigludo7 in #290 @@ -75,18 +84,21 @@ The API definition(s) are based on * Add quote-marks for `lastLocationTime` - examples by @maxl2287 in #287 ## geofencing-subscriptions v0.4.0-rc.1 +**Please be aware that this release contains breaking changes compared to the previous version.** + +### Breaking Changes + +* Some error status and codes have been updated by @maxl2287 in #284 ### Added * Add test-definitions for HTTP-422 error-cases for geofencing-API by @maxl2287 in #289 -* Add MultiSIM section to info.description by @jlurien in https://github.com/camaraproject/DeviceLocation/pull/291 - +* Add MultiSIM section to info.description by @jlurien in #291 ### Changed * Decrease radius minimum to "1" for circle-area by @maxl2287 in #285 * Error schemas updated with enums by @maxl2287 in #284 -* Some error status and codes have been updated by @maxl2287 in #284 * Add a note that initial events will be counted when `subscriptionMaxEvents` is combined with initialEvent=true by @maxl2287 in #284 * Add pattern for x-correlator by @bigludo7 in #290 * Update 429 error message by @bigludo7 in #290 @@ -106,8 +118,8 @@ This **public release** contains the definition and documentation of * geofencing-subscriptions v0.3.0 The API definition(s) are based on -* Commonalities r2.2 -* Identity and Consent Management r2.2 +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 **Changelog since v0.2.0** diff --git a/README.md b/README.md index 3d9f065..f1d62dc 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,6 @@ Repository to describe, develop, document and test the DeviceLocation API family - **location-verification v2.0.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.1/code/API_definitions/location-verification.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-verification.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-verification.yaml) - **location-retrieval v0.4.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.1/code/API_definitions/location-retrieval.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-retrieval.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/location-retrieval.yaml) - **geofencing-subscriptions v0.4.0-rc.1** [[YAML OAS]](https://github.com/camaraproject/DeviceLocation/blob/r2.1/code/API_definitions/geofencing-subscriptions.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/geofencing-subscriptions.yaml&nocors) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceLocation/r2.1/code/API_definitions/geofencing-subscriptions.yaml) -* Previous releases and pre-releases of the repository are available in https://github.com/camaraproject/DeviceLocation/releases -* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceLocation/blob/main/CHANGELOG.md) ## Contributing * Meetings are held virtually From dab656809775bd5cb826f6373de7f8e6da4128f7 Mon Sep 17 00:00:00 2001 From: Maximilian Laue Date: Tue, 4 Feb 2025 15:11:04 +0100 Subject: [PATCH 25/25] fix: update API Readiness Checklist documentation reference --- .../geofencing-subscriptions-API-Readiness-Checklist.md | 2 +- .../location-retrieval-API-Readiness-Checklist.md | 2 +- .../location-verification-API-Readiness-Checklist.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md index e360c49..1f06c95 100644 --- a/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/geofencing-subscriptions-API-Readiness-Checklist.md @@ -21,4 +21,4 @@ Checklist for geofencing-subscriptions 0.4.0-rc.1 in r2.1 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). +The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine). \ No newline at end of file diff --git a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md index 3c0cb9e..ecc637a 100644 --- a/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-retrieval-API-Readiness-Checklist.md @@ -21,4 +21,4 @@ Checklist for location-retrieval 0.4.0-rc.1 in r2.1 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). \ No newline at end of file +The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine). \ No newline at end of file diff --git a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md index e1c66c7..976cb4a 100644 --- a/documentation/API_documentation/location-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/location-verification-API-Readiness-Checklist.md @@ -21,4 +21,4 @@ Checklist for location-verification 2.0.0-rc.1 in r2.1 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). +The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine). \ No newline at end of file