Merge pull request #118 from maheshc01/main

Release r2.1 (M3 rc.1) PR ⚠️ REQUIRES RELEASE MANAGEMENT APPROVAL ⚠️

Author: maheshc01

CHANGELOG.md

@@ -4,42 +4,61 @@ NOTE:
 
 ## Table of contents
 
-- **[v0.4.1-alpha.1](#v041---alpha1)**
+- **[r2.1](#r21)**
 - **[r1.2](#r12)**
 - **[r1.1 - rc](#r11---rc)**
 
 **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.**
 
-The below sections record the changes for each API version in each (pre-)release as follows:
+The below sections record the changes for each API version in each release as follows:
 
-* for the 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
 
-# v0.4.1-alpha.1
+# r2.1
+## Release Notes
 
-This alpha pre-release contains the definition and documentation of
-* connectivity-insights v0.4.1-alpha.1
-* connectivity-insights-subscriptions v0.4.1-alpha.1
-* application-profiles v0.3.1-alpha.1
+This release contains the definition and documentation of
+* connectivity-insights v0.5.0-rc.1
+* connectivity-insights-subscriptions v0.5.0-rc.1
+* application-profiles v0.4.0-rc.1
 
 The API definition(s) are based on
-* Commonalities 0.5.0-alpha.1 (r2.1)
-* Identity and Consent Management v0.3.0-alpha.1 (r2.1)
+* Commonalities 0.5.0-rc.1 (r2.2)
+* Identity and Consent Management v0.3.0-rc.1 (r2.2)
+
+*  **r2.1 release of ConnectivityInsights has the following API definitions:**
 
-It contains the following changes compared to the last public release [r1.2](#r12)
+    *  **connectivity-insights v0.5.0-rc.1**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights.yaml)
+
+    *  **connectivity-insights-subscriptions v0.5.0-rc.1**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/connectivity-insights-subscriptions.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/connectivity-insights-subscriptions.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/connectivity-insights-subscriptions.yaml)
+
+    *  **application-profiles v0.4.0-rc.1**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/application-profiles.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/application-profiles.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/application-profiles.yaml)
 
 ### Changed
-All changes are to align with Commonalities 0.5.0-alpha.1
+All changes are to align with Commonalities 0.5.0-rc.1 and Identity and Consent management 0.3.0-rc.1, as captured in PR #116
 * Error names and structures updated
+* removed `406` and `5xx` errors
 * `security` component updated
 * `x-camara-commonalities` version updated
+* Device identifier updates
 * Template text for identifying devices updated
 * Test guidelines updated to incorporate changed errrors.
 * New API Readiness checklist used and updated
+* For more details see [Scope for Spring 25 CAMARA meta release](https://github.com/camaraproject/ConnectivityInsights/issues/106)
+
+**Full Changelog**: https://github.com/camaraproject/connectivityInsights/compare/r1.2...r2.1
 
 # r1.2
 ## Release Notes

README.md

@@ -21,26 +21,29 @@ Repository to describe, develop, document and test the Connectivity Insights API
 
 * 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**.
 
-*  **[r1.2](https://github.com/camaraproject/ConnectivityInsights/tree/r1.2) is the first public release of connectivity insights with the following API definitions:**
+* `NEW`: Release r2.1 features following APIs:
 
-    *  **Connectivity Insights API v0.4.0**
-    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml&nocors)
-    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml)
-    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml)
+  *  **[r2.1](https://github.com/camaraproject/ConnectivityInsights/tree/r2.1) release of connectivity insights with the following API definitions:**
 
-    *  **Connectivity Insights Subscriptions API v0.4.0**
-    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights-subscriptions.yaml&nocors)
-    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
-    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
+      *  **Connectivity Insights API v0.5.0-rc.1**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights.yaml)
 
-    *  **Application Profiles API 0.3.0**
-    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml&nocors)
-    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml)
-    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml)
+      *  **Connectivity Insights Subscriptions API v0.5.0-rc.1**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights-subscriptions.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights-subscriptions.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights-subscriptions.yaml)
 
-  * Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases
+      *  **Application Profiles API 0.4.0-rc.1**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/application-profiles.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/application-profiles.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/application-profiles.yaml)
 
-  * Note: This being the first public release of the API, list of changes as compared to previous public release is not applicable and hence not provided.
+
+* The latest public release is available here: https://github.com/camaraproject/ConnectivityInsights/releases/latest
+* Other releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases
+* For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectivityInsights/blob/main/CHANGELOG.md)
 
 ## Contributing
 * Meetings <!-- for new API families request a meeting link from the LF admin team or replace the information with the existing meeting information (of the API family) -->

code/API_definitions/application-profiles.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Connectivity Insights - Application Profiles
-  version: 0.3.1-alpha.1
+  version: 0.4.0-rc.1
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -17,11 +17,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 Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
+    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
 
@@ -40,7 +40,7 @@ info:
   x-camara-commonalities: 0.5
 
 servers:
-  - url: "{apiRoot}/application-profiles/v0alpha1"
+  - url: "{apiRoot}/application-profiles/v0.4rc1"
     variables:
       apiRoot:
         default: http://localhost:9091
@@ -222,6 +222,7 @@ components:
       description: Correlation id for the different services
       schema:
         type: string
+        pattern: ^[a-zA-Z0-9-]{0,55}$
   schemas:
     Duration:
       type: object
@@ -268,7 +269,7 @@ components:
         - Gbps
         - Tbps
 
-    packetDelayBudget:
+    PacketDelayBudget:
       description: |
         The packet delay budget is the maximum allowable one-way latency
         between the customer's device and the gateway from the operator's
@@ -280,7 +281,7 @@ components:
       allOf:
         - $ref: "#/components/schemas/Duration"
 
-    packetErrorLossRate:
+    PacketErrorLossRate:
       type: integer
       description: |
         The exponential power of the allowable error loss rate 10^(-N).
@@ -303,7 +304,7 @@ components:
       maximum: 10
       example: 3
 
-    jitter:
+    Jitter:
       description: |
         The jitter requirement aims to limit the maximum variation in
         round-trip packet delay for the 99th percentile of traffic, following
@@ -315,13 +316,13 @@ components:
       allOf:
         - $ref: "#/components/schemas/Duration"
 
-    targetMinDownstreamRate:
+    TargetMinDownstreamRate:
       description: |
         This is the target minimum downstream rate.
       allOf:
         - $ref: "#/components/schemas/Rate"
 
-    targetMinUpstreamRate:
+    TargetMinUpstreamRate:
       description: |
         This is the target minimum upstream rate.
       allOf:
@@ -351,15 +352,15 @@ components:
       type: object
       properties:
         packetDelayBudget:
-          $ref: "#/components/schemas/packetDelayBudget"
+          $ref: "#/components/schemas/PacketDelayBudget"
         targetMinDownstreamRate:
-          $ref: "#/components/schemas/targetMinDownstreamRate"
+          $ref: "#/components/schemas/TargetMinDownstreamRate"
         targetMinUpstreamRate:
-          $ref: "#/components/schemas/targetMinUpstreamRate"
+          $ref: "#/components/schemas/TargetMinUpstreamRate"
         packetlossErrorRate:
-          $ref: "#/components/schemas/packetErrorLossRate"
+          $ref: "#/components/schemas/PacketErrorLossRate"
         jitter:
-          $ref: "#/components/schemas/jitter"
+          $ref: "#/components/schemas/Jitter"
 
     ErrorInfo:
       type: object
@@ -533,10 +534,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.