You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CHANGELOG.md
+35
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ NOTE:
4
4
5
5
## Table of contents
6
6
7
+
-**[r2.2](#r22)**
7
8
-**[r2.1](#r21)**
8
9
-**[r1.2](#r12)**
9
10
-**[r1.1 - rc](#r11---rc)**
@@ -17,6 +18,40 @@ The below sections record the changes for each API version in each release as fo
17
18
* for subsequent release-candidate(s), only the delta to the previous release-candidate
18
19
* for a public release, the consolidated changes since the previous public release
19
20
21
+
# r2.2
22
+
## Release Notes
23
+
24
+
This release contains the definition and documentation of
25
+
* connectivity-insights v0.5.0
26
+
* connectivity-insights-subscriptions v0.5.0
27
+
* application-profiles v0.4.0
28
+
29
+
The API definition(s) are based on
30
+
* Commonalities 0.5.0
31
+
* Identity and Consent Management v0.3.0
32
+
33
+
***r2.2 release of ConnectivityInsights has the following API definitions:**
34
+
35
+
***connectivity-insights v0.5.0**
36
+
[[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)
37
+
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.yaml)
[[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)
42
+
[[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)
[[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)
47
+
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.2/code/API_definitions/application-profiles.yaml)
Repository to describe, develop, document and test the Connectivity Insights API family
10
+
Repository to describe, develop, document and test the Connectivity Insights APIs
11
11
12
12
## Scope
13
13
* Service APIs for “Connectivity Insights” (see APIBacklog.md)
14
-
* It provides the customer with the ability to:
15
-
* 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.
16
-
* NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G.
14
+
* It provides the API consumer with the ability to:
15
+
* share key details about their applications that are relevant for network-related decisions across various CAMARA APIs.
16
+
* gain visibility into network quality, allowing them to
17
+
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.
18
+
* enables application developers to receive continuous updates
19
+
about network quality through event notifications.
20
+
* NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
17
21
* Describe, develop, document and test the APIs (with 1-2 Telcos)
18
22
* Started: November 2023
19
23
20
24
## Release Information
21
25
22
26
* 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**.
23
27
24
-
*`NEW`: Release r2.1 features following APIs:
28
+
*`NEW`: This public release r2.2 features the following APIs:
25
29
26
-
***[r2.1](https://github.com/camaraproject/ConnectivityInsights/tree/r2.1) release of connectivity insights with the following API definitions:**
30
+
***[r2.2](https://github.com/camaraproject/ConnectivityInsights/tree/r2.2) release of connectivity insights with the following API definitions:**
27
31
28
-
***Connectivity Insights API v0.5.0-rc.1**
29
-
[[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)
30
-
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights.yaml)
[[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)
34
+
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.yaml)
* **Connectivity Insights Subscriptions API v0.5.0-rc.1**
34
-
[[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)
35
-
[[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)
* **Connectivity Insights Subscriptions API v0.5.0**
38
+
[[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)
39
+
[[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)
[[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)
40
-
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/application-profiles.yaml)
[[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)
44
+
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/application-profiles.yaml)
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.
25
25
26
-
# Identifying the device from the access token
27
-
28
-
This API requires the API consumer to identify a device as the subject of the API as follows:
29
-
- 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.
30
-
31
-
- 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.
32
-
33
-
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.
34
-
35
-
## Error handling:
36
-
- 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.
37
-
38
-
- 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.
0 commit comments