fix for issue #91 and #94

camaraproject · Aug 21, 2024 · 630372b · 630372b
1 parent 0e6c9e7
commit 630372b
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 62 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,8 +26,8 @@ This release contains the definition and documentation of
 * 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
 

diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml
@@ -17,26 +17,14 @@ info:
     throughput). This scope will be expanded further based on addtional
     requirements from other applicable CAMARA APIs
 
-    # Authorization and Authentication
+    ### Authorization and authentication
 
-      [Camara Security and Interoperability Profile](https://github.com/
-      camaraproject/IdentityAndConsentManagement/blob/r0.2.0-rc.2/
-      documentation/CAMARA-Security-Interoperability.md) provides details on
-      how a client requests an access token.
+    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.
 
-      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.
+    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.
+
+    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.
 
-      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.
   x-camara-commonalities: 0.4.0
 
 servers:

diff --git a/code/API_definitions/connectivity-insights-subscriptions.yaml b/code/API_definitions/connectivity-insights-subscriptions.yaml
@@ -2,6 +2,8 @@ openapi: 3.0.3
 info:
   title: Connectivity Insights
   version: 0.4.0-rc.1
+  contact:
+    email: [email protected]
   x-camara-commonalities: 0.4.0
   description: |
     With CAMARA Connectivity Insights, application developers gain essential
@@ -55,26 +57,13 @@ info:
       connectivity insights resource server to the webhook url provided
       by notification listener.
 
-    # Authorization and Authentication
+    ### Authorization and authentication
 
-      [Camara Security and Interoperability Profile](https://github.com/
-      camaraproject/IdentityAndConsentManagement/blob/r0.2.0-rc.2/
-      documentation/CAMARA-Security-Interoperability.md) provides details on
-      how a client requests an access token.
+    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.
 
-      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.
+    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.
 
-      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.
+    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.
 
   license:
     name: Apache 2.0
@@ -861,7 +850,7 @@ components:
         source:
           $ref: "#/components/schemas/Source"
         type:
-          $ref: "#/components/schemas/Event-typeNotification"
+          $ref: "#/components/schemas/EventTypeNotification"
         specversion:
           type: string
           description: |
@@ -885,29 +874,29 @@ components:
         mapping:
           org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-met:
             "#/components/schemas/EventNetworkQualityMet"
-           org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-not-met:
+          org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-not-met:
             "#/components/schemas/EventNetworkQualityNotMet"
           org.camaraproject.connectivityinsights.v0.eventSubscriptionEnds:
             "#/components/schemas/EventSubscriptionEnds"
 
-  EventNetworkQualityMet:
+    EventNetworkQualityMet:
       description: event structure for Network Quality met
       allOf:
         - $ref: "#/components/schemas/CloudEvent"
         - type: object
           properties:
             data:
               $ref: "#/components/schemas/NetworkQualityInsight"
-              
-  EventNetworkQualityNotMet:
+
+    EventNetworkQualityNotMet:
       description: event structure for Network Quality not met
       allOf:
         - $ref: "#/components/schemas/CloudEvent"
         - type: object
           properties:
             data:
-              $ref: "#/components/schemas/NetworkQualityInsight"              
-              
+              $ref: "#/components/schemas/NetworkQualityInsight"
+
 
     EventSubscriptionEnds:
       description: event structure for event subscription ends

diff --git a/code/API_definitions/connectivity-insights.yaml b/code/API_definitions/connectivity-insights.yaml
@@ -2,6 +2,8 @@ openapi: 3.0.3
 info:
   title: Connectivity Insights
   version: 0.4.0-rc.1
+  contact:
+    email: [email protected]
   x-camara-commonalities: 0.4.0
   description: |
     With CAMARA Connectivity Insights, application developers gain essential
@@ -38,7 +40,8 @@ info:
       3. Optional: use the `connectivity-insights-subscriptions` API to receive
       notifications of network quality.
 
-    todo: sequence diagram
+    Following diagram shows the interaction between different components
+      ![Sequence Diagram](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/main/documentation/API_documentation/ConnectivityInsights-SequenceDiagram.png)
 
     # Identifying the device
 
@@ -70,26 +73,13 @@ info:
     be explicitly documented in the guidelines.
 
 
-    # Authorization and Authentication
+    ### Authorization and authentication
 
-      [Camara Security and Interoperability Profile](https://github.com/
-      camaraproject/IdentityAndConsentManagement/blob/r0.2.0-rc.2/
-      documentation/CAMARA-Security-Interoperability.md) provides details on
-      how a client requests an access token.
+    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.
 
-      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.
+    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.
 
-      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.
+    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.
 
   license:
     name: Apache 2.0

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-profile v0.3.0-rc.1
+Checklist for application-profiles v0.3.0-rc.1
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|