Merge pull request #121 from maheshc01/main

Release PR for Spring 25 M4 milestone

Author: maheshc01

CHANGELOG.md

@@ -4,6 +4,7 @@ NOTE:
 
 ## Table of contents
 
+- **[r2.2](#r22)**
 - **[r2.1](#r21)**
 - **[r1.2](#r12)**
 - **[r1.1 - rc](#r11---rc)**
@@ -17,6 +18,40 @@ 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.2
+## Release Notes
+
+This release contains the definition and documentation of
+* connectivity-insights v0.5.0
+* connectivity-insights-subscriptions v0.5.0
+* application-profiles v0.4.0
+
+The API definition(s) are based on
+* Commonalities 0.5.0
+* Identity and Consent Management v0.3.0
+
+*  **r2.2 release of ConnectivityInsights has the following API definitions:**
+
+    *  **connectivity-insights v0.5.0**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.yaml)
+
+    *  **connectivity-insights-subscriptions v0.5.0**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.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/2.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
+
+    *  **application-profiles v0.4.0**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.2/code/API_definitions/application-profiles.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.2/code/API_definitions/application-profiles.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.2/code/API_definitions/application-profiles.yaml)
+
+### Changed
+* Changes requested by Release Management for M4
+
+**Full Changelog**: https://github.com/camaraproject/connectivityInsights/compare/r1.2...r2.2
+
 # r2.1
 ## Release Notes
 

README.md

@@ -7,38 +7,42 @@
 <a href="https://github.com/camaraproject/ConnectivityInsights/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/ConnectivityInsights?style=plastic"></a>
 
 # Connectivity Insights
-Repository to describe, develop, document and test the Connectivity Insights API family
+Repository to describe, develop, document and test the Connectivity Insights APIs
 
 ## Scope
 * Service APIs for “Connectivity Insights” (see APIBacklog.md)
-* It provides the customer with the ability to:
-  * define intents in the form of policy thresholds for QoS metrics against the device and the application service. The API service will alert the consumers if and when the policy has breached.
-  * NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G.
+* It provides the API consumer with the ability to:
+  * share key details about their applications that are relevant for network-related decisions across various CAMARA APIs.
+  * gain visibility into network quality, allowing them to
+check if their application's network requirements can be met for a given user session. Based on the API’s response, developers can make informed decisions - like requesting a network boost through CAMARA Quality on Demand API or adjusting application settings (e.g. adjust video resolution) to ensure the best possible user experience.
+  * enables application developers to receive continuous updates
+about network quality through event notifications.
+  * NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
 * Describe, develop, document and test the APIs (with 1-2 Telcos)
 * Started: November 2023
 
 ## Release Information
 
 * 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**.
 
-* `NEW`: Release r2.1 features following APIs:
+* `NEW`: This public release r2.2 features the following APIs:
 
-  *  **[r2.1](https://github.com/camaraproject/ConnectivityInsights/tree/r2.1) release of connectivity insights with the following API definitions:**
+  *  **[r2.2](https://github.com/camaraproject/ConnectivityInsights/tree/r2.2) release of connectivity insights with the following API definitions:**
 
-      *  **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)
+      *  **Connectivity Insights API v0.5.0**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.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)
+      *  **Connectivity Insights Subscriptions API v0.5.0**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.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/r2.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
 
-      *  **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)
+      *  **Application Profiles API 0.4.0**
+    [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/application-profiles.yaml&nocors)
+    [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/application-profiles.yaml)
+    [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/application-profiles.yaml)
 
 
 * The latest public release is available here: https://github.com/camaraproject/ConnectivityInsights/releases/latest

code/API_definitions/application-profiles.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Connectivity Insights - Application Profiles
-  version: 0.4.0-rc.1
+  version: 0.4.0
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -23,24 +23,10 @@ info:
 
     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
-
-    This API requires the API consumer to identify a device as the subject of the API as follows:
-    - When the API is invoked using a two-legged access token, the subject will be identified from the optional `device` object, which therefore MUST be provided.
-
-    - When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.
-
-    This approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.
-
-    ## Error handling:
-    - If the subject cannot be identified from the access token and the optional `device` object is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.
-
-    - If the subject can be identified from the access token and the optional `device` object is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same device is identified by these two methods, as the server is unable to make this comparison.
-
   x-camara-commonalities: 0.5
 
 servers:
-  - url: "{apiRoot}/application-profiles/v0.4rc1"
+  - url: "{apiRoot}/application-profiles/v0.4"
     variables:
       apiRoot:
         default: http://localhost:9091

code/API_definitions/connectivity-insights-subscriptions.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Connectivity Insights
-  version: 0.5.0-rc.1
+  version: 0.5.0
   x-camara-commonalities: 0.5
   description: |
     With CAMARA Connectivity Insights, application developers gain essential
@@ -42,7 +42,7 @@ info:
 
 
       Following diagram shows the interaction between different components
-      ![Sequence Diagram](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/main/documentation/API_documentation/ConnectivityInsights-SequenceDiagram.png)
+      ![Sequence Diagram](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/documentation/API_documentation/ConnectivityInsights-SequenceDiagram.png)
 
     ### Notification callback
 
@@ -117,7 +117,7 @@ externalDocs:
   url: https://github.com/camaraproject/ConnectivityInsights/
 
 servers:
-  - url: "{apiRoot}/connectivity-insights-subscriptions/v0.5rc1"
+  - url: "{apiRoot}/connectivity-insights-subscriptions/v0.5"
     variables:
       apiRoot:
         default: http://localhost:9091
@@ -356,6 +356,7 @@ components:
       schema:
         type: string
         pattern: ^[a-zA-Z0-9-]{0,55}$
+        example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
   headers:
     x-correlator:
       description: Correlation id for the different services
@@ -408,8 +409,6 @@ components:
             The address to which events shall be delivered using the selected
             protocol.
           example: "https://endpoint.example.com/sink"
-        sinkCredential:
-          $ref: "#/components/schemas/SinkCredential"
         types:
           description: |
             Camara Event types eligible to be delivered by this subscription.
@@ -434,13 +433,23 @@ components:
           type: string
           format: date-time
           description: Date when the event subscription will begin/began
+            It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/
+            rfc3339#section-5.6) and must have time zone.
+            Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which
+            allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
+          example: "2023-07-03T12:27:08.312Z"
         expiresAt:
           type: string
           format: date-time
           description: |
             Date when the event subscription will expire. Only provided when
             `subscriptionExpireTime` is indicated by API client or Telco
             Operator has specific policy about that.
+            It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/
+            rfc3339#section-5.6) and must have time zone.
+            Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
+            2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
+          example: "2023-07-03T12:27:08.312Z"
         status:
           type: string
           description: |-
@@ -710,10 +719,12 @@ components:
         subscriptionExpireTime:
           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.
+            It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
+            Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
+          example: "2023-07-03T12:27:08.312Z"
         subscriptionMaxEvents:
           type: integer
           description: |
@@ -743,7 +754,9 @@ components:
             - PLAIN
             - ACCESSTOKEN
             - REFRESHTOKEN
-          description: "The type of the credential."
+          description: |
+            The type of the credential.
+            Note: Type of the credential - MUST be set to ACCESSTOKEN for now
       discriminator:
         propertyName: credentialType
         mapping:
@@ -785,7 +798,7 @@ components:
           $ref: "#/components/schemas/Protocol"
         sink:
           type: string
-          format: url
+          format: uri
           description: |
             The address to which events shall be delivered using the selected
             protocol.
@@ -951,8 +964,12 @@ components:
       type: string
       format: date-time
       description: |
-        Timestamp of when the occurrence happened. Must adhere to RFC 3339.
-      example: "2018-04-05T17:31:00Z"
+        Timestamp of when the occurrence happened.
+        It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/
+        rfc3339#section-5.6) and must have time zone.
+        Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
+        2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
+      example: "2023-07-03T12:27:08.312Z"
 
     EventTypeNotification:
       type: string

code/API_definitions/connectivity-insights.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.3
 info:
   title: Connectivity Insights
-  version: 0.5.0-rc.1
+  version: 0.5.0
   x-camara-commonalities: 0.5
   description: |
     With CAMARA Connectivity Insights, application developers gain essential
@@ -39,7 +39,7 @@ info:
       notifications of network quality.
 
     Following diagram shows the interaction between different components
-      ![Sequence Diagram](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/main/documentation/API_documentation/ConnectivityInsights-SequenceDiagram.png)
+      ![Sequence Diagram](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/documentation/API_documentation/ConnectivityInsights-SequenceDiagram.png)
 
     # Authorization and authentication
 
@@ -72,7 +72,7 @@ externalDocs:
   url: https://github.com/camaraproject/ConnectivityInsights
 
 servers:
-  - url: "{apiRoot}/connectivity-insights/v0.5rc1"
+  - url: "{apiRoot}/connectivity-insights/v0.5"
     variables:
       apiRoot:
         default: http://localhost:9091
@@ -173,6 +173,11 @@ components:
             current date and time is used and network data for the monitoring
             data aggregation is used to check network performance against the
             application profile defined.
+            It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/
+            rfc3339#section-5.6) and must have time zone.
+            Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
+            2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
+          example: "2023-07-03T12:27:08.312Z"
 
     NetworkQualityInsightResponse:
       type: object