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

PR for M3 r1.1

CHANGELOG.md

@@ -4,47 +4,47 @@ NOTE:
 
 ## Table of contents
 
-- [r1.1 - rc]
+- **[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:
 
-* 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 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
 
+# r1.1 - rc
 ## Release Notes
 
 This release contains the definition and documentation of
-* Connectivity Insights API
-* Application Profiles API
+* Connectivity Insights API v0.4.0
+* Connectivity Insights Subscriptions API v0.4.0
+* Application Profiles API v0.3.0
 
 The API definition(s) are based on
-* Commonalities v0.4.0-rc.1
-* Identity and Consent Management v0.2.0-rc.1
-
+* Commonalities v0.4.0-rc.2
+* Identity and Consent Management v0.2.0-rc.2
 
 ## Connectivity Insights API v0.4.0-rc.1
 
-** 0.4.0-rc.1 is the first release-candidate version for connectivity insights**
-
-
-### Main changes
-- This version is primarily to align with the changes to Commonalities 0.4-rc.1 and Identity and Consent Management v0.2.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.
 
 - API definition **with inline documentation**:
   - View it on ReDoc:
     - [connectivity-insights.yaml](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights.yaml&nocors)
-    
-    - [application-profiles.yaml](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml&nocors)
-  - [View it on Swagger Editor]
-    - [connectivity-insights.yaml]((https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights.yaml))
-      - [application-profiles.yaml]((https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml))
+
+
+  - View it on Swagger Editor
+    - [connectivity-insights.yaml](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights.yaml)
+
   - OpenAPI
     -  [connectivity-insights.yaml](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights.yaml)
-    -  [application-profiles.yaml](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml)
+
 
 ### Added
   - Gherkin `.feature` file in Test_definitions
@@ -56,3 +56,59 @@ The API definition(s) are based on
   - Compliance with DeviceIdentifier schema
   - 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
+
+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.
+
+- API definition **with inline documentation**:
+  - View it on ReDoc:
+    - [connectivity-insights-subscriptions.yaml](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights-subscriptions.yaml&nocors)
+
+
+  - View it on Swagger Editor
+    - [connectivity-insights-subscriptions.yaml](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights-subscriptions.yaml)
+
+  - OpenAPI
+    -  [connectivity-insights-subscriptions.yaml](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights-subscriptions.yaml)
+
+
+### Added
+  - Gherkin `.feature` file in Test_definitions
+  - Implementation of ICM consent guidelines
+  - Addition of `x-camara-commonalities` object to YAML
+  - Documentation: added warning about use of `networkAccessIdentifier`, added User Story
+
+### Changed
+  - Compliance with DeviceIdentifier schema
+  - 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
+
+
+
+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.
+
+- API definition **with inline documentation**:
+  - View it on ReDoc:
+    - [application-profiles.yaml](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml&nocors)
+
+  - View it on Swagger Editor
+    - [application-profiles.yaml](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml)
+
+  - OpenAPI
+    -  [application-profiles.yaml](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml)
+
+### Added
+
+- Gherkin
+`.feature` file in Test_definitions
+
+### Changed
+
+- 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

README.md

@@ -21,9 +21,9 @@ Repository to describe, develop, document and test the Connectivity Insights API
 ## 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/§repo_name§/releases -->
+ 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/§repo_name§/blob/main/CHANGELOG.md) -->
+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) -->