Merge pull request #41 from eric-murray/eric-murray-patch-3

Release r1.2 (Fall'25 M4)

Author: bigludo7

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog ConnectedNetworkType
 ## Table of Contents
+- **[r1.2](#r12)**
 - [r1.1](#r11)
 
 **Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**
@@ -13,6 +14,70 @@ The below sections record the changes for each API version in each release as fo
 
 Note: this API had former releases in the [DeviceStatus](https://github.com/camaraproject/DeviceStatus) repository
 
+# r1.2
+## Release Notes
+
+This public release contains the definition and documentation of
+* connected-network-type v0.2.0
+* connected-network-type-subscriptions v0.2.0
+
+The API definition(s) are based on
+* Commonalities v0.6.0 (r3.3)
+* Identity and Consent Management v0.4.0 (r3.3)
+
+## connected-network-type v0.2.0
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/ConnectedNetworkType/blob/r1.2/code/API_definitions/connected-network-type.yaml)
+
+### Added
+
+### Changed
+* Make lastStatusTime mandatory in 200 responses of the API by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/17
+* Update x-correlator schema by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/26
+* Update error response documentation in OAS definitions by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/27
+* Commonalities alignement for connected network type subscription & connected network type by @bigludo7 in https://github.com/camaraproject/ConnectedNetworkType/pull/34
+* Fix feature files for compliance with centralised linting rules by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/38
+* Further fix for feature files for compliance with centralised linting rules by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/40
+* Migrate to centralized linting workflows by @hdamker-bot in https://github.com/camaraproject/ConnectedNetworkType/pull/37
+
+### Fixed
+
+### Removed
+* Remove AUTHENTICATION_REQUIRED error code by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/12
+* Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/24
+
+## connected-network-type-subscriptions v0.2.0
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/ConnectedNetworkType/blob/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml)
+
+### Added
+* Add subscription started & updated events by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/31
+
+### Changed
+* change sink format to format: uri by @maxl2287 in https://github.com/camaraproject/ConnectedNetworkType/pull/16
+* Update x-correlator schema by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/26
+* Rename subscription-ends event to subscription-ended by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/28
+* Update error response documentation in OAS definitions by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/27
+* Commonalities alignement for connected network type subscription & connected network type by @bigludo7 in https://github.com/camaraproject/ConnectedNetworkType/pull/34
+* Fix feature files for compliance with centralised linting rules by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/38
+* Further fix for feature files for compliance with centralised linting rules by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/40
+* Migrate to centralized linting workflows by @hdamker-bot in https://github.com/camaraproject/ConnectedNetworkType/pull/37
+
+### Fixed
+* remove "Generic High Entropy Secret" by @maxl2287 in https://github.com/camaraproject/ConnectedNetworkType/pull/15
+
+### Removed
+* Remove AUTHENTICATION_REQUIRED error code by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/12
+* Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/24
+
+**Full Changelog**: https://github.com/camaraproject/ConnectedNetworkType/commits/r1.2
+
 # r1.1
 ## Release Notes
 
@@ -38,8 +103,8 @@ The API definition(s) are based on
 * Update x-correlator schema by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/26
 * Update error response documentation in OAS definitions by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/27
 * Commonalities alignement for connected network type subscription & connected network type by @bigludo7 in https://github.com/camaraproject/ConnectedNetworkType/pull/34
-### Fixed
 
+### Fixed
 
 ### Removed
 * Remove AUTHENTICATION_REQUIRED error code by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/12
@@ -70,4 +135,3 @@ The API definition(s) are based on
 * Update OAS and test definitions to remove IDENTIFIER_MISMATCH error code by @eric-murray in https://github.com/camaraproject/ConnectedNetworkType/pull/24
 
 **Full Changelog**: https://github.com/camaraproject/ConnectedNetworkType/commits/r1.1
-

README.md

@@ -25,12 +25,18 @@ Sandbox API Repository to describe, develop, document, and test the ConnectedNet
 
 ## Release Information
 
-The latest public release of the Device Status repository, including the ConnectedNetworkType API, is available here: https://github.com/camaraproject/DeviceStatus/releases/latest
-<!-- Optional: an explicit listing of the latest (pre-)release with additional information, e.g. links to the API definitions -->
-<!-- In addition use/uncomment one or multiple the following alternative options when becoming applicable -->
-Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectedNetworkType/releases
-<!-- The latest public release is available here: https://github.com/camaraproject/ConnectedNetworkType/releases/latest -->
-<!-- For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectedNetworkType/blob/main/CHANGELOG.md) -->
+**NEW: the latest public release of the ConnectedNetworkType repository is available [here](https://github.com/camaraproject/ConnectedNetworkType/releases/latest), with the following API versions:**
+
+  * **connected-network-type v0.2.0**  
+  [[YAML]](https://github.com/camaraproject/ConnectedNetworkType/blob/r1.2/code/API_definitions/connected-network-type.yaml)
+  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type.yaml&nocors)
+  [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type.yaml)
+  * **connected-network-type-subscriptions v0.2.0**  
+  [[YAML]](https://github.com/camaraproject/ConnectedNetworkType/blob/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml)
+  [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml&nocors)
+  [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/ConnectedNetworkType/r1.2/code/API_definitions/connected-network-type-subscriptions.yaml)
+
+Pre-releases of this sub project are available [here](https://github.com/camaraproject/ConnectedNetworkType/releases). For changes see the [change log](https://github.com/camaraproject/ConnectedNetworkType/blob/main/CHANGELOG.md).
 
 ## Contributing
 

code/API_definitions/connected-network-type-subscriptions.yaml

@@ -22,7 +22,7 @@ info:
        - `3G`: if device is connected to the 3G network technology (alternative indicators such as "H" or "H+" may be displayed on the device)
        - `4G`: if device is connected to the 4G network technology (alternative indicators such as "LTE" or "LTE+" may be displayed on the device)
        - `5G`: if device is connected to the 5G network technology
-       - `UNKNOWN`: if connection [technology] can not be determined
+       - `UNKNOWN`: if connection technology can not be determined
 
     # API Functionality
 
@@ -116,14 +116,14 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.2.0
   x-camara-commonalities: 0.6
 externalDocs:
   description: Product documentation at Camara
-  url: https://github.com/camaraproject/DeviceStatus
+  url: https://github.com/camaraproject/ConnectedNetworkType
 
 servers:
-  - url: "{apiRoot}/connected-network-type-subscriptions/vwip"
+  - url: "{apiRoot}/connected-network-type-subscriptions/v0.2"
     variables:
       apiRoot:
         default: http://localhost:9091
@@ -163,7 +163,7 @@ paths:
               summary: "notifications callback"
               description: |
                 Important: this endpoint is to be implemented by the API consumer.
-                The Device status server will call this endpoint whenever the connected network type of the device changes.
+                The connectivity network type status server will call this endpoint whenever the connected network type of the device changes.
               operationId: postNotification
               parameters:
                 - $ref: "#/components/parameters/x-correlator"
@@ -423,7 +423,7 @@ components:
         types:
           description: |
             Camara Event types eligible to be delivered by this subscription.
-            Note: For the current Commonalities API design guidelines, only one event type per subscription is allowed, yet in the following releases use of array of event types SHALL be specified without changing this definition.
+            Note: As of now we enforce to have only event type per subscription.
           type: array
           minItems: 1
           maxItems: 1
@@ -463,16 +463,16 @@ components:
           type: string
           format: date-time
           example: 2023-01-17T13:18:23.682Z
-          description: The subscription expiration time (in date-time format) requested by the API consumer. Up to API project decision to keep it.
+          description: The subscription expiration time (in date-time format) requested by the API consumer.
         subscriptionMaxEvents:
           type: integer
-          description: Identifies the maximum number of event reports to be generated (>=1) requested by the API consumer - Once this number is reached, the subscription ends. Up to API project decision to keep it.
+          description: Identifies the maximum number of event reports to be generated (>=1) requested by the API consumer - Once this number is reached, the subscription ends.
           minimum: 1
           example: 5
         initialEvent:
           type: boolean
           description: |
-            Set to `true` by API consumer if consumer wants to get an event as soon as the subscription is created and current situation reflects event request.Up to API project decision to keep it.
+            Set to `true` by API consumer if consumer wants to get an event as soon as the subscription is created and current situation reflects event request.
             Example: Consumer request area entered event. If consumer sets initialEvent to true and device is already in the geofence, an event is triggered
 
     SinkCredential:
@@ -726,7 +726,7 @@ components:
 
     SubscriptionId:
       type: string
-      description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as `subscriptionId` as per [Commonalities Event Notification Model](https://github.com/camaraproject/Commonalities/blob/r2.3/documentation/API-design-guidelines.md#122-event-notification).
+      description: The unique identifier of the subscription in the scope of the subscription manager. When this information is contained within an event notification, this concept SHALL be referred as subscriptionId as per Commonalities Event Notification Model.
       example: qs15-h556-rt89-1298
 
     Device:

code/API_definitions/connected-network-type.yaml

@@ -82,14 +82,14 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.2.0
   x-camara-commonalities: 0.6
 externalDocs:
   description: Product documentation at CAMARA
-  url: https://github.com/camaraproject/DeviceStatus
+  url: https://github.com/camaraproject/ConnectedNetworkType
 
 servers:
-  - url: "{apiRoot}/connected-network-type/vwip"
+  - url: "{apiRoot}/connected-network-type/v0.2"
     variables:
       apiRoot:
         default: http://localhost:9091

code/Test_definitions/connected-network-type-subscriptions.feature

@@ -1,5 +1,5 @@
 # connected-network-type-subscriptions
-Feature: CAMARA Connected Network Type Subscriptions API, vwip
+Feature: CAMARA Connected Network Type Subscriptions API, v0.2.0
   # Operations createConnectedNetworkTypeSubscription, retrieveConnectedNetworkTypeSubscriptionList, retrieveConnectedNetworkTypeSubscription and deleteConnectedNetworkTypeSubscription
 
   # Input to be provided by the implementation to the tester
@@ -12,11 +12,13 @@ Feature: CAMARA Connected Network Type Subscriptions API, vwip
   # * (optional: Additional devices object which supports 2G, 3G, 4G and/or 5G)
   # * The known connected Generation of Mobile Communication Technology.
   # * A sink-url identified as "callbackUrl", which receives notifications
+  # * apiRoot: API root of the server URL
   #
   # References to OAS spec schemas refer to schemas specifies in connected-network-type-subscriptions.yaml
 
   Background: Connected Network Type Subscriptions setup
-    Given the resource "{apiroot}/connected-network-type-subscriptions/vwip" as base-url
+    Given an environment at "apiRoot"
+    And the resource "/connected-network-type-subscriptions/v0.2"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
 

code/Test_definitions/connected-network-type.feature

@@ -1,5 +1,5 @@
 # connected-network-type
-Feature: CAMARA Connected Network Type API, vwip - Operation getConnectedNetworkType
+Feature: CAMARA Connected Network Type API, v0.2.0 - Operation getConnectedNetworkType
   # Input to be provided by the implementation to the tester
   #
   # Implementation indications:
@@ -9,11 +9,13 @@ Feature: CAMARA Connected Network Type API, vwip - Operation getConnectedNetwork
   # * A device object where the tester can select between multiple network types.
   # * (optional: Additional devices object which supports 2G, 3G, 4G and/or 5G)
   # * The known connected Generation of Mobile Communication Technology.
+  # * apiRoot: API root of the server URL
   #
   # References to OAS spec schemas refer to schemas specifies in connected-network-type.yaml
 
   Background: Common Connected Network Type setup
-    Given the resource "{api-root}/connected-network-type/vwip/retrieve" set as base-url
+    Given an environment at "apiRoot"
+    And the resource "/connected-network-type/v0.2/retrieve"
     And the header "Content-Type" is set to "application/json"
     And the header "Authorization" is set to a valid access token
     And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"

documentation/API_documentation/connected-network-type-API-Readiness-Checklist.md

@@ -1,12 +1,12 @@
 # API Readiness Checklist
 
-Checklist for connected-network-type 0.2.0-rc.1 in r1.1.
+Checklist for connected-network-type 0.2.0 in r1.2
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
 |  1 | API definition                               |   M   |         M         |    M    |    M   |   Y   | [/code/API_definitions/connected-network-type.yaml](/code/API_definitions/connected-network-type.yaml) |
-|  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)   |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |   Y   |   [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3)   |
+|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |   Y   |   [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3)   |
 |  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y   |      |
 |  5 | API documentation                            |   M   |         M         |    M    |    M   |   Y   | inline in YAML |
 |  6 | User stories                                 |   O   |         O         |    O    |    M   |  N    |      |

documentation/API_documentation/connected-network-type-subscriptions-API-Readiness-Checklist.md

@@ -1,12 +1,12 @@
 # API Readiness Checklist
 
-Checklist for connected-network-type-subscriptions 0.2.0-rc.1 in r1.1.
+Checklist for connected-network-type-subscriptions 0.2.0 in r1.2
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
 |  1 | API definition                               |   M   |         M         |    M    |    M   |   Y   | [/code/API_definitions/connected-network-type-subscriptions.yaml](/code/API_definitions/connected-network-type-subscriptions.yaml) |
-|  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)    |
+|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |   Y   |  [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3)    |
+|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |   Y   |  [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3)    |
 |  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y   |      |
 |  5 | API documentation                            |   M   |         M         |    M    |    M   |   Y   | inline in YAML |
 |  6 | User stories                                 |   O   |         O         |    O    |    M   |  N    |      |