Merge pull request #98 from camaraproject/Kevsy-patch-5

Release PR for public release r1.2 (M4)
camaraproject · Sep 10, 2024 · db8ab9e · db8ab9e
2 parents 75f0a0e + 8af3207
commit db8ab9e
Show file tree

Hide file tree

Showing 9 changed files with 89 additions and 55 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@ NOTE:
 
 ## Table of contents
 
+- **[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.**
@@ -17,19 +18,56 @@ respect to the previous pre-release
 * for a public API version, the consolidated changes since the release of the
 previous public API version
 
+# r1.2
+## Release Notes
+
+This release contains the definition and documentation of
+* connectivity-insights v0.4.0
+* connectivity-insights-subscriptions v0.4.0
+* application-profiles v0.3.0
+
+The API definition(s) are based on
+* Commonalities v0.4.0
+* Identity and Consent Management v0.2.0
+
+*  **r1.2 release of ConnectivityInsights has the following API definitions:**
+
+    *  **connectivity-insights 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)
+
+    *  **connectivity-insights-subscriptions 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)
+
+    *  **application-profiles v0.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)
+
+### Added
+* n/a
+### Changed
+* n/a
+
+**Full Changelog**: https://github.com/camaraproject/connectivityInsights/commits/r1.2
+
+
 # r1.1 - rc
 ## Release Notes
 
 This release contains the definition and documentation of
-* Connectivity Insights API v0.4.0
-* Connectivity Insights Subscriptions API v0.4.0
-* Application Profiles API v0.3.0
+* connectivity-insights v0.4.0-rc.1
+* connectivity-insights-subscriptions v0.4.0-rc.1
+* application-profiles v0.3.0-rc.1
 
 The API definition(s) are based on
 * Commonalities v0.4.0-rc.2
 * Identity and Consent Management v0.2.0-rc.2
 
-## Connectivity Insights API v0.4.0-rc.1
+## connectivity-insights v0.4.0-rc.1
 
 0.4.0-rc.1 is the first release of the API. The version is aligned with
 Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2.
@@ -57,7 +95,7 @@ Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2.
   - Error model alignment, including device identifier-related errors
   - Updated the API Readiness Checklist to the new format
 
-## Connectivity Insights Subscriptions API v0.4.0-rc.1
+## connectivity-insights-subscriptions v0.4.0-rc.1
 
 0.4.0-rc.1 is the first release of the API. The version is aligned with
 Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2.
@@ -85,9 +123,7 @@ Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2.
   - Error model alignment, including device identifier-related errors
   - Updated the API Readiness Checklist to the new format
 
-## Application Profiles API 0.3.0-rc.1
-
-
+## application-profiles 0.3.0-rc.1
 
 0.3.0-rc.1 is the first release of the API. The version is aligned with
 Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2.
@@ -112,3 +148,5 @@ Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2.
 - Aligned the network monitoring KPIs to match with Quality on Demand CAMARA API.
 - update the end points to make it more developer friendly based on the discussion in the API working group.
 - Updated the API Readiness Checklist to the new format
+
+**Full Changelog**: https://github.com/camaraproject/ConnectivityInsights/commits/r1.1
diff --git a/README.md b/README.md
@@ -10,20 +10,37 @@
 Repository to describe, develop, document and test the Connectivity Insights API family
 
 ## Scope
-* Service APIs for “Connectivity Insights” (see APIBacklog.md)  
-* It provides the customer with the ability to:  
+* 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.  
-* Describe, develop, document and test the APIs (with 1-2 Telcos)  
+  * NOTE: The scope of this API family 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
-* Location: virtually  
 
 ## Release Information
-<!-- Use/uncomment one or multiple the following options -->
-<!-- The sub project has no (pre)releases yet, work in progress is within the main branch -->
- Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases
-<!-- The latest public release is available here: https://github.com/camaraproject/§repo_name§/releases/latest -->
-For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectivityInsights/blob/main/CHANGELOG.md)
+
+* 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:**
+
+    *  **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)
+
+    *  **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)
+
+    *  **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)
+
+  * Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases
+
+  * 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.
 
 ## 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) -->

diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml
@@ -1,9 +1,7 @@
 openapi: 3.0.3
 info:
   title: Connectivity Insights - Application Profiles
-  version: 0.3.0-rc.1
-  contact:
-    email: [email protected]
+  version: 0.3.0
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -28,7 +26,7 @@ info:
   x-camara-commonalities: 0.4.0
 
 servers:
-  - url: "{apiRoot}/application-profiles/v0.3rc1"
+  - url: "{apiRoot}/application-profiles/v0.3"
     variables:
       apiRoot:
         default: http://localhost:9091

diff --git a/code/API_definitions/connectivity-insights-subscriptions.yaml b/code/API_definitions/connectivity-insights-subscriptions.yaml
@@ -1,9 +1,7 @@
 openapi: 3.0.3
 info:
   title: Connectivity Insights
-  version: 0.4.0-rc.1
-  contact:
-    email: [email protected]
+  version: 0.4.0
   x-camara-commonalities: 0.4.0
   description: |
     With CAMARA Connectivity Insights, application developers gain essential
@@ -74,7 +72,7 @@ externalDocs:
   url: https://github.com/camaraproject/ConnectivityInsights
 
 servers:
-  - url: "{apiRoot}/connectivity-insights-subscriptions/v0.4rc1/check-network-quality"
+  - url: "{apiRoot}/connectivity-insights-subscriptions/v0.4/check-network-quality"
     variables:
       apiRoot:
         default: http://localhost:9091
@@ -100,8 +98,7 @@ paths:
         - $ref: "#/components/parameters/x-correlator"
       security:
         - openId:
-            - connectivity-insights-subscriptions:org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-met:create
-            - connectivity-insights-subscriptions:org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-not-met:create
+            - connectivity-insights-subscriptions:org.camaraproject.connectivity-insights-subscriptions.v0.network-quality:create
 
       requestBody:
         content:
@@ -779,7 +776,7 @@ components:
           type: array
           items:
             type: string
-            example: org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-met
+            example: org.camaraproject.connectivity-insights-subscriptions.v0.network-quality
         config:
           $ref: "#/components/schemas/Config"
 
@@ -872,32 +869,20 @@ components:
       discriminator:
         propertyName: "type"
         mapping:
-          org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-met:
-            "#/components/schemas/EventNetworkQualityMet"
-          org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-not-met:
-            "#/components/schemas/EventNetworkQualityNotMet"
+          org.camaraproject.connectivity-insights-subscriptions.v0.network-quality:
+            "#/components/schemas/EventNetworkQuality"
           org.camaraproject.connectivityinsights.v0.eventSubscriptionEnds:
             "#/components/schemas/EventSubscriptionEnds"
 
-    EventNetworkQualityMet:
-      description: event structure for Network Quality met
+    EventNetworkQuality:
+      description: event structure for Network Quality
       allOf:
         - $ref: "#/components/schemas/CloudEvent"
         - type: object
           properties:
             data:
               $ref: "#/components/schemas/NetworkQualityInsight"
 
-    EventNetworkQualityNotMet:
-      description: event structure for Network Quality not met
-      allOf:
-        - $ref: "#/components/schemas/CloudEvent"
-        - type: object
-          properties:
-            data:
-              $ref: "#/components/schemas/NetworkQualityInsight"
-
-
     EventSubscriptionEnds:
       description: event structure for event subscription ends
       allOf:
@@ -950,8 +935,7 @@ components:
         event-type - Event triggered when an event-type event occurred
         subscription-ends: Event triggered when the subscription ends
       enum:
-        - org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-met
-        - org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-not-met
+        - org.camaraproject.connectivity-insights-subscriptions.v0.network-quality
         - org.camaraproject.connectivity-insights-subscriptions.v0.subscription-ends
     ErrorInfo:
       type: object

diff --git a/code/API_definitions/connectivity-insights.yaml b/code/API_definitions/connectivity-insights.yaml
@@ -1,9 +1,7 @@
 openapi: 3.0.3
 info:
   title: Connectivity Insights
-  version: 0.4.0-rc.1
-  contact:
-    email: [email protected]
+  version: 0.4.0
   x-camara-commonalities: 0.4.0
   description: |
     With CAMARA Connectivity Insights, application developers gain essential
@@ -90,7 +88,7 @@ externalDocs:
   url: https://github.com/camaraproject/ConnectivityInsights
 
 servers:
-  - url: "{apiRoot}/connectivity-insights/v0.4rc1"
+  - url: "{apiRoot}/connectivity-insights/v0.4"
     variables:
       apiRoot:
         default: http://localhost:9091

diff --git a/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md b/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md
@@ -1,6 +1,6 @@
 # Connectivity Insights API Readiness minimum criteria checklist
 
-Checklist for connectivity-insights v0.4.0-rc.1
+Checklist for connectivity-insights v0.4.0 in r1.2
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|

diff --git a/...PI_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md b/...PI_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md
@@ -1,6 +1,6 @@
 # Connectivity Insights Subscriptions API Readiness minimum criteria checklist
 
-Checklist for connectivity-insights-subscriptions v0.4.0-rc.1
+Checklist for connectivity-insights-subscriptions v0.4.0 in r1.2
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|

diff --git a/documentation/API_documentation/README.MD b/documentation/API_documentation/README.MD
diff --git a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md
@@ -1,6 +1,6 @@
 # API Readiness Checklist
 
-Checklist for application-profiles v0.3.0-rc.1
+Checklist for application-profiles v0.3.0 in r1.2
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|