Merge pull request #126 from eric-murray/eric-murray-patch-2

eric-murray · web-flow · commit 8827bb92cbac · 2025-07-22T10:49:04.000+01:00
Release r2.1 (Fall'25 M3)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,8 @@
 For the best results, use the latest published release.**
 
 ## Table of Contents
-- **[r1.3](#r13)**
+- **[r2.1](#r21)**
+- [r1.3](#r13)
 - [r1.2](#r12)
 - [r1.1](#r11)
 - [v0.1.0](#v010)
@@ -15,6 +16,41 @@ The below sections record the changes for each API version in each release as fo
 * for subsequent release-candidate(s), only the delta to the previous release-candidate
 * for a public release, the consolidated changes since the previous public release
 
+# r2.1
+## Release Notes
+
+This public release contains the definition and documentation of
+* device-identifier v0.3.0-rc.1
+
+The API definition(s) are based on
+* Commonalities 0.6.0-rc.1
+* Identity and Consent Management v0.4.0-rc.1
+
+## device-identifier v0.3.0-rc.1
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r2.1/code/API_definitions/device-identifier.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r2.1/code/API_definitions/device-identifier.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceIdentifier/blob/r2.1/code/API_definitions/device-identifier.yaml)
+
+There are no breaking changes compared to v0.2.0
+
+### Added
+* Add additional endpoint to provide PPID as physical device identifier by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/110
+* Add additional text on undocumented erros to OAS definition by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/120
+
+### Changed
+* Update x-correlator pattern by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/121
+
+### Fixed
+* Fix typos in feature files by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/125
+
+### Removed
+* Remove AUTHENTICATION_REQUIRED error code by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/111
+* Remove IDENTIFIER_MISMATCH error and include optional device property in 200 response by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/122
+
+**Full Changelog**: https://github.com/camaraproject/DeviceIdentifier/compare/r1.3...r2.1
+
 # r1.3
 ## Release Notes
 
diff --git a/code/API_definitions/device-identifier.yaml b/code/API_definitions/device-identifier.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Device Identifier
-  version: wip
+  version: 0.3.0-rc.1
   description: |
     # Summary
 
@@ -30,7 +30,7 @@ info:
 
     The mobile network associates this device identifier with the mobile subscription currently using the device. The mobile subscription is defined by the Subscriber Identity Module (SIM) currently active in the mobile device. This may be a removable SIM or an eSIM. In either case, it is possible for the association between the device identifier and subscription to change - for example, when a physical SIM is transferred to another mobile device.
 
-    ![Device Identifier API Overview](https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/main/documentation/API_documentation/resources/Device_Identifier_Overview.png)
+    ![Device Identifier API Overview](https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r2.1/documentation/API_documentation/resources/Device_Identifier_Overview.png)
 
     The Device Identifier API allows the API consumer to obtain the IMEI and associated parameters for a specified mobile subscription identifier or equivalent. The mobile subscription can be identified using one or more of the following subscription identifiers:
     - the subscription phone number (also known as MSISDN)
@@ -166,14 +166,14 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  x-camara-commonalities: 0.5
+  x-camara-commonalities: 0.6
 
 externalDocs:
   description: Product documentation at CAMARA
   url: https://github.com/camaraproject/DeviceIdentifier
 
 servers:
-  - url: "{apiRoot}/device-identifier/vwip"
+  - url: "{apiRoot}/device-identifier/v0.3rc1"
     variables:
       apiRoot:
         default: http://localhost:9091
diff --git a/code/Test_definitions/device-identifier-retrieveIdentifier.feature b/code/Test_definitions/device-identifier-retrieveIdentifier.feature
@@ -1,5 +1,5 @@
 @device-identifier-retrieveIdentifier
-Feature: Camara Mobile Device Identifer API, vwip - Operation: retrieveIdentifier
+Feature: Camara Mobile Device Identifer API, v0.3.0-rc.1 - Operation: retrieveIdentifier
 
 # Input to be provided by the implementation to the tests
 # References to OAS spec schemas refer to schemas specified in /code/API_definitions/device-identifier.yaml
@@ -30,7 +30,7 @@ Feature: Camara Mobile Device Identifer API, vwip - Operation: retrieveIdentifie
 
   Background: Common Device Identifier retrieveIdentifier setup
     Given an environment at "apiRoot"
-    And the resource "/device-identifier/vwip/retrieve-identifier"
+    And the resource "/device-identifier/v0.3rc1/retrieve-identifier"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
diff --git a/code/Test_definitions/device-identifier-retrievePPID.feature b/code/Test_definitions/device-identifier-retrievePPID.feature
@@ -1,5 +1,5 @@
 @device-identifier-retrievePPID
-Feature: Camara Mobile Device Identifer API, vwip - Operation: retrievePPID
+Feature: Camara Mobile Device Identifer API, v0.3.0-rc.1 - Operation: retrievePPID
 
 # Input to be provided by the implementation to the tests
 # References to OAS spec schemas refer to schemas specified in /code/API_definitions/device-identifier.yaml
@@ -32,7 +32,7 @@ Feature: Camara Mobile Device Identifer API, vwip - Operation: retrievePPID
 
   Background: Common Device Identifier retrievePPID setup
     Given an environment at "apiRoot"
-    And the resource "/device-identifier/vwip/retrieve-ppid"
+    And the resource "/device-identifier/v0.3rc1/retrieve-ppid"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
diff --git a/code/Test_definitions/device-identifier-retrieveType.feature b/code/Test_definitions/device-identifier-retrieveType.feature
@@ -1,5 +1,5 @@
 @device-identifier-retrieveType
-Feature: Camara Mobile Device Identifer API, vwip - Operation: retrieveType
+Feature: Camara Mobile Device Identifer API, v0.3.0-rc.1 - Operation: retrieveType
 
 # Input to be provided by the implementation to the tests
 # References to OAS spec schemas refer to schemas specified in /code/API_definitions/device-identifier.yaml
@@ -30,7 +30,7 @@ Feature: Camara Mobile Device Identifer API, vwip - Operation: retrieveType
 
   Background: Common Device Identifier retrieveType setup
     Given an environment at "apiRoot"
-    And the resource "/device-identifier/vwip/retrieve-type"
+    And the resource "/device-identifier/v0.3rc1/retrieve-type"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
diff --git a/documentation/API_documentation/device-identifier-API-Readiness-Checklist.md b/documentation/API_documentation/device-identifier-API-Readiness-Checklist.md
@@ -1,22 +1,22 @@
 # API Readiness Checklist
 
-Checklist for device-identifier v0.2.0 in r1.3.
+Checklist for device-identifier v0.3.0-rc.1 in r2.1.
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status  | Reference information |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:-------------------------------------------------------------------------------:|
 |  1 | API definition                               |   M   |         M         |    M    |    M   |  Y   | [device-identifier.yaml](/code/API_definitions/device-identifier.yaml)          |
-|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y   | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3)                                                                      |
-|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3)                                                                     |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |  Y   | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2)                                                                      |
+|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.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   | [Device Identifier User Story.md](/documentation/API_documentation/Device%20Identifier%20User%20Story.md) |
-|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  Y   | [device-identifier-retrieveIdentifier.feature](/code/Test_definitions/device-identifier-retrieveIdentifier.feature)<br>[device-identifier-retrieveType.feature](/code/Test_definitions/device-identifier-retrieveType.feature) |
+|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  Y   | [device-identifier-retrieveIdentifier.feature](/code/Test_definitions/device-identifier-retrieveIdentifier.feature)<br>[device-identifier-retrieveType.feature](/code/Test_definitions/device-identifier-retrieveType.feature)<br>[device-identifier-retrievePPID.feature](/code/Test_definitions/device-identifier-retrievePPID.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   | r1.3                                                                            |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   | r2.1                                                                            |
 | 11 | Change log updated                           |   M   |         M         |    M    |    M   |  Y   | [CHANGELOG.md](/CHANGELOG.md)                                                   |
 | 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |  N   |                                                                                 |
-| 13 | API description (for marketing)              |   O   |         O         |    M    |    M   |      | [wiki link](https://lf-camaraproject.atlassian.net/wiki/xxx) |
+| 13 | API description (for marketing)              |   O   |         O         |    M    |    M   |  Y   | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/goHWB) |
 
 To fill the checklist:
 - in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.
