Skip to content

Commit f636f94

Browse files
authored
Merge pull request #118 from maheshc01/main
Release r2.1 (M3 rc.1) PR ⚠️ REQUIRES RELEASE MANAGEMENT APPROVAL ⚠️
2 parents cb95d65 + 02f8afd commit f636f94

9 files changed

+132
-116
lines changed

CHANGELOG.md

+36-17
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,61 @@ NOTE:
44

55
## Table of contents
66

7-
- **[v0.4.1-alpha.1](#v041---alpha1)**
7+
- **[r2.1](#r21)**
88
- **[r1.2](#r12)**
99
- **[r1.1 - rc](#r11---rc)**
1010

1111
**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.**
1212

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:
1414

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
2119

22-
# v0.4.1-alpha.1
20+
# r2.1
21+
## Release Notes
2322

24-
This alpha pre-release contains the definition and documentation of
25-
* connectivity-insights v0.4.1-alpha.1
26-
* connectivity-insights-subscriptions v0.4.1-alpha.1
27-
* application-profiles v0.3.1-alpha.1
23+
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
2827

2928
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:**
3233

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)
37+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights.yaml)
38+
39+
* **connectivity-insights-subscriptions v0.5.0-rc.1**
40+
[[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)
42+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/connectivity-insights-subscriptions.yaml)
43+
44+
* **application-profiles v0.4.0-rc.1**
45+
[[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)
47+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.1/code/API_definitions/application-profiles.yaml)
3448

3549
### Changed
36-
All changes are to align with Commonalities 0.5.0-alpha.1
50+
All changes are to align with Commonalities 0.5.0-rc.1 and Identity and Consent management 0.3.0-rc.1, as captured in PR #116
3751
* Error names and structures updated
52+
* removed `406` and `5xx` errors
3853
* `security` component updated
3954
* `x-camara-commonalities` version updated
55+
* Device identifier updates
4056
* Template text for identifying devices updated
4157
* Test guidelines updated to incorporate changed errrors.
4258
* New API Readiness checklist used and updated
59+
* For more details see [Scope for Spring 25 CAMARA meta release](https://github.com/camaraproject/ConnectivityInsights/issues/106)
60+
61+
**Full Changelog**: https://github.com/camaraproject/connectivityInsights/compare/r1.2...r2.1
4362

4463
# r1.2
4564
## Release Notes

README.md

+18-15
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,29 @@ Repository to describe, develop, document and test the Connectivity Insights API
2121

2222
* 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**.
2323

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:
2525

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)
29-
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml)
26+
* **[r2.1](https://github.com/camaraproject/ConnectivityInsights/tree/r2.1) release of connectivity insights with the following API definitions:**
3027

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)
34-
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
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)
31+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights.yaml)
3532

36-
* **Application Profiles API 0.3.0**
37-
[[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)
39-
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml)
33+
* **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)
36+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/connectivity-insights-subscriptions.yaml)
4037

41-
* 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)
41+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.1/code/API_definitions/application-profiles.yaml)
4242

43-
* 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)
4447

4548
## Contributing
4649
* 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) -->

code/API_definitions/application-profiles.yaml

+19-18
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.3
22
info:
33
title: Connectivity Insights - Application Profiles
4-
version: 0.3.1-alpha.1
4+
version: 0.4.0-rc.1
55
license:
66
name: Apache 2.0
77
url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -17,11 +17,11 @@ info:
1717
1818
# Authorization and authentication
1919
20-
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.
2121
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.
2323
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.
2525
2626
# Identifying the device from the access token
2727
@@ -40,7 +40,7 @@ info:
4040
x-camara-commonalities: 0.5
4141

4242
servers:
43-
- url: "{apiRoot}/application-profiles/v0alpha1"
43+
- url: "{apiRoot}/application-profiles/v0.4rc1"
4444
variables:
4545
apiRoot:
4646
default: http://localhost:9091
@@ -222,6 +222,7 @@ components:
222222
description: Correlation id for the different services
223223
schema:
224224
type: string
225+
pattern: ^[a-zA-Z0-9-]{0,55}$
225226
schemas:
226227
Duration:
227228
type: object
@@ -268,7 +269,7 @@ components:
268269
- Gbps
269270
- Tbps
270271

271-
packetDelayBudget:
272+
PacketDelayBudget:
272273
description: |
273274
The packet delay budget is the maximum allowable one-way latency
274275
between the customer's device and the gateway from the operator's
@@ -280,7 +281,7 @@ components:
280281
allOf:
281282
- $ref: "#/components/schemas/Duration"
282283

283-
packetErrorLossRate:
284+
PacketErrorLossRate:
284285
type: integer
285286
description: |
286287
The exponential power of the allowable error loss rate 10^(-N).
@@ -303,7 +304,7 @@ components:
303304
maximum: 10
304305
example: 3
305306

306-
jitter:
307+
Jitter:
307308
description: |
308309
The jitter requirement aims to limit the maximum variation in
309310
round-trip packet delay for the 99th percentile of traffic, following
@@ -315,13 +316,13 @@ components:
315316
allOf:
316317
- $ref: "#/components/schemas/Duration"
317318

318-
targetMinDownstreamRate:
319+
TargetMinDownstreamRate:
319320
description: |
320321
This is the target minimum downstream rate.
321322
allOf:
322323
- $ref: "#/components/schemas/Rate"
323324

324-
targetMinUpstreamRate:
325+
TargetMinUpstreamRate:
325326
description: |
326327
This is the target minimum upstream rate.
327328
allOf:
@@ -351,15 +352,15 @@ components:
351352
type: object
352353
properties:
353354
packetDelayBudget:
354-
$ref: "#/components/schemas/packetDelayBudget"
355+
$ref: "#/components/schemas/PacketDelayBudget"
355356
targetMinDownstreamRate:
356-
$ref: "#/components/schemas/targetMinDownstreamRate"
357+
$ref: "#/components/schemas/TargetMinDownstreamRate"
357358
targetMinUpstreamRate:
358-
$ref: "#/components/schemas/targetMinUpstreamRate"
359+
$ref: "#/components/schemas/TargetMinUpstreamRate"
359360
packetlossErrorRate:
360-
$ref: "#/components/schemas/packetErrorLossRate"
361+
$ref: "#/components/schemas/PacketErrorLossRate"
361362
jitter:
362-
$ref: "#/components/schemas/jitter"
363+
$ref: "#/components/schemas/Jitter"
363364

364365
ErrorInfo:
365366
type: object
@@ -533,10 +534,10 @@ components:
533534
value:
534535
status: 429
535536
code: QUOTA_EXCEEDED
536-
message: Either out of resource quota or reaching rate limiting.
537+
message: Out of resource quota.
537538
GENERIC_429_TOO_MANY_REQUESTS:
538-
description: API Server request limit is overpassed
539+
description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached
539540
value:
540541
status: 429
541542
code: TOO_MANY_REQUESTS
542-
message: Either out of resource quota or reaching rate limiting.
543+
message: Rate limit reached.

0 commit comments

Comments
 (0)