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
+36-17
Original file line number
Diff line number
Diff line change
@@ -4,42 +4,61 @@ NOTE:
4
4
5
5
## Table of contents
6
6
7
-
-**[v0.4.1-alpha.1](#v041---alpha1)**
7
+
-**[r2.1](#r21)**
8
8
-**[r1.2](#r12)**
9
9
-**[r1.1 - rc](#r11---rc)**
10
10
11
11
**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.**
12
12
13
-
The below sections record the changes for each API version in each (pre-)release as follows:
13
+
The below sections record the changes for each API version in each release as follows:
14
14
15
-
* for the first alpha or release-candidate API version, all changes since the
16
-
release of the previous public API version
17
-
* for subsequent alpha or release-candidate API versions, the delta with
18
-
respect to the previous pre-release
19
-
* for a public API version, the consolidated changes since the release of the
20
-
previous public API version
15
+
* for an alpha release, the delta with respect to the previous release
16
+
* for the first release-candidate, all changes since the last public release
17
+
* for subsequent release-candidate(s), only the delta to the previous release-candidate
18
+
* for a public release, the consolidated changes since the previous public release
21
19
22
-
# v0.4.1-alpha.1
20
+
# r2.1
21
+
## Release Notes
23
22
24
-
This alpha pre-release contains the definition and documentation of
This release contains the definition and documentation of
24
+
* connectivity-insights v0.5.0-rc.1
25
+
* connectivity-insights-subscriptions v0.5.0-rc.1
26
+
* application-profiles v0.4.0-rc.1
28
27
29
28
The API definition(s) are based on
30
-
* Commonalities 0.5.0-alpha.1 (r2.1)
31
-
* Identity and Consent Management v0.3.0-alpha.1 (r2.1)
29
+
* Commonalities 0.5.0-rc.1 (r2.2)
30
+
* Identity and Consent Management v0.3.0-rc.1 (r2.2)
31
+
32
+
***r2.1 release of ConnectivityInsights has the following API definitions:**
32
33
33
-
It contains the following changes compared to the last public release [r1.2](#r12)
34
+
***connectivity-insights v0.5.0-rc.1**
35
+
[[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)
36
+
[[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/2.1/code/API_definitions/connectivity-insights-subscriptions.yaml&nocors)
41
+
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/connectivity-insights-subscriptions.yaml)
[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/application-profiles.yaml&nocors)
46
+
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/application-profiles.yaml)
Copy file name to clipboardexpand all lines: README.md
+18-15
Original file line number
Diff line number
Diff line change
@@ -21,26 +21,29 @@ Repository to describe, develop, document and test the Connectivity Insights API
21
21
22
22
* 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
23
24
-
***[r1.2](https://github.com/camaraproject/ConnectivityInsights/tree/r1.2) is the first public release of connectivity insights with the following API definitions:**
24
+
*`NEW`: Release r2.1 features following APIs:
25
25
26
-
***Connectivity Insights API v0.4.0**
27
-
[[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)
28
-
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml)
***[r2.1](https://github.com/camaraproject/ConnectivityInsights/tree/r2.1) release of connectivity insights with the following API definitions:**
30
27
31
-
***Connectivity Insights Subscriptions API v0.4.0**
32
-
[[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)
33
-
[[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)
[[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/r1.2/code/API_definitions/application-profiles.yaml&nocors)
38
-
[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.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)
* Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases
38
+
* **Application Profiles API 0.4.0-rc.1**
39
+
[[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)
* 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.
43
+
44
+
* The latest public release is available here: https://github.com/camaraproject/ConnectivityInsights/releases/latest
45
+
* Other releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases
46
+
* For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectivityInsights/blob/main/CHANGELOG.md)
44
47
45
48
## Contributing
46
49
* 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) -->
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.
20
+
The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.
21
21
22
-
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.
22
+
The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.
23
23
24
-
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.
24
+
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
26
# Identifying the device from the access token
27
27
@@ -40,7 +40,7 @@ info:
40
40
x-camara-commonalities: 0.5
41
41
42
42
servers:
43
-
- url: "{apiRoot}/application-profiles/v0alpha1"
43
+
- url: "{apiRoot}/application-profiles/v0.4rc1"
44
44
variables:
45
45
apiRoot:
46
46
default: http://localhost:9091
@@ -222,6 +222,7 @@ components:
222
222
description: Correlation id for the different services
223
223
schema:
224
224
type: string
225
+
pattern: ^[a-zA-Z0-9-]{0,55}$
225
226
schemas:
226
227
Duration:
227
228
type: object
@@ -268,7 +269,7 @@ components:
268
269
- Gbps
269
270
- Tbps
270
271
271
-
packetDelayBudget:
272
+
PacketDelayBudget:
272
273
description: |
273
274
The packet delay budget is the maximum allowable one-way latency
274
275
between the customer's device and the gateway from the operator's
@@ -280,7 +281,7 @@ components:
280
281
allOf:
281
282
- $ref: "#/components/schemas/Duration"
282
283
283
-
packetErrorLossRate:
284
+
PacketErrorLossRate:
284
285
type: integer
285
286
description: |
286
287
The exponential power of the allowable error loss rate 10^(-N).
@@ -303,7 +304,7 @@ components:
303
304
maximum: 10
304
305
example: 3
305
306
306
-
jitter:
307
+
Jitter:
307
308
description: |
308
309
The jitter requirement aims to limit the maximum variation in
309
310
round-trip packet delay for the 99th percentile of traffic, following
0 commit comments