Skip to content

Commit a0fffe4

Browse files
authored
Merge pull request #121 from maheshc01/main
Release PR for Spring 25 M4 milestone
2 parents f636f94 + 21e1bda commit a0fffe4

14 files changed

+724
-137
lines changed

CHANGELOG.md

+35
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ NOTE:
44

55
## Table of contents
66

7+
- **[r2.2](#r22)**
78
- **[r2.1](#r21)**
89
- **[r1.2](#r12)**
910
- **[r1.1 - rc](#r11---rc)**
@@ -17,6 +18,40 @@ The below sections record the changes for each API version in each release as fo
1718
* for subsequent release-candidate(s), only the delta to the previous release-candidate
1819
* for a public release, the consolidated changes since the previous public release
1920

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)
38+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.yaml)
39+
40+
* **connectivity-insights-subscriptions v0.5.0**
41+
[[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)
43+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
44+
45+
* **application-profiles v0.4.0**
46+
[[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)
48+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/2.2/code/API_definitions/application-profiles.yaml)
49+
50+
### Changed
51+
* Changes requested by Release Management for M4
52+
53+
**Full Changelog**: https://github.com/camaraproject/connectivityInsights/compare/r1.2...r2.2
54+
2055
# r2.1
2156
## Release Notes
2257

README.md

+22-18
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,42 @@
77
<a href="https://github.com/camaraproject/ConnectivityInsights/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/ConnectivityInsights?style=plastic"></a>
88

99
# Connectivity Insights
10-
Repository to describe, develop, document and test the Connectivity Insights API family
10+
Repository to describe, develop, document and test the Connectivity Insights APIs
1111

1212
## Scope
1313
* 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.
1721
* Describe, develop, document and test the APIs (with 1-2 Telcos)
1822
* Started: November 2023
1923

2024
## Release Information
2125

2226
* 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**.
2327

24-
* `NEW`: Release r2.1 features following APIs:
28+
* `NEW`: This public release r2.2 features the following APIs:
2529

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:**
2731

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)
32+
* **Connectivity Insights API v0.5.0**
33+
[[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)
35+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights.yaml)
3236

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)
37+
* **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)
40+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/connectivity-insights-subscriptions.yaml)
3741

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)
42+
* **Application Profiles API 0.4.0**
43+
[[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)
45+
[[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/code/API_definitions/application-profiles.yaml)
4246

4347

4448
* The latest public release is available here: https://github.com/camaraproject/ConnectivityInsights/releases/latest

code/API_definitions/application-profiles.yaml

+2-16
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.4.0-rc.1
4+
version: 0.4.0
55
license:
66
name: Apache 2.0
77
url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -23,24 +23,10 @@ info:
2323
2424
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
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.
39-
4026
x-camara-commonalities: 0.5
4127

4228
servers:
43-
- url: "{apiRoot}/application-profiles/v0.4rc1"
29+
- url: "{apiRoot}/application-profiles/v0.4"
4430
variables:
4531
apiRoot:
4632
default: http://localhost:9091

code/API_definitions/connectivity-insights-subscriptions.yaml

+27-10
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.3
22
info:
33
title: Connectivity Insights
4-
version: 0.5.0-rc.1
4+
version: 0.5.0
55
x-camara-commonalities: 0.5
66
description: |
77
With CAMARA Connectivity Insights, application developers gain essential
@@ -42,7 +42,7 @@ info:
4242
4343
4444
Following diagram shows the interaction between different components
45-
![Sequence Diagram](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/main/documentation/API_documentation/ConnectivityInsights-SequenceDiagram.png)
45+
![Sequence Diagram](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/documentation/API_documentation/ConnectivityInsights-SequenceDiagram.png)
4646
4747
### Notification callback
4848
@@ -117,7 +117,7 @@ externalDocs:
117117
url: https://github.com/camaraproject/ConnectivityInsights/
118118

119119
servers:
120-
- url: "{apiRoot}/connectivity-insights-subscriptions/v0.5rc1"
120+
- url: "{apiRoot}/connectivity-insights-subscriptions/v0.5"
121121
variables:
122122
apiRoot:
123123
default: http://localhost:9091
@@ -356,6 +356,7 @@ components:
356356
schema:
357357
type: string
358358
pattern: ^[a-zA-Z0-9-]{0,55}$
359+
example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
359360
headers:
360361
x-correlator:
361362
description: Correlation id for the different services
@@ -408,8 +409,6 @@ components:
408409
The address to which events shall be delivered using the selected
409410
protocol.
410411
example: "https://endpoint.example.com/sink"
411-
sinkCredential:
412-
$ref: "#/components/schemas/SinkCredential"
413412
types:
414413
description: |
415414
Camara Event types eligible to be delivered by this subscription.
@@ -434,13 +433,23 @@ components:
434433
type: string
435434
format: date-time
436435
description: Date when the event subscription will begin/began
436+
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/
437+
rfc3339#section-5.6) and must have time zone.
438+
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which
439+
allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
440+
example: "2023-07-03T12:27:08.312Z"
437441
expiresAt:
438442
type: string
439443
format: date-time
440444
description: |
441445
Date when the event subscription will expire. Only provided when
442446
`subscriptionExpireTime` is indicated by API client or Telco
443447
Operator has specific policy about that.
448+
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/
449+
rfc3339#section-5.6) and must have time zone.
450+
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
451+
2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
452+
example: "2023-07-03T12:27:08.312Z"
444453
status:
445454
type: string
446455
description: |-
@@ -710,10 +719,12 @@ components:
710719
subscriptionExpireTime:
711720
type: string
712721
format: date-time
713-
example: 2023-01-17T13:18:23.682Z
714722
description: |
715723
The subscription expiration time (in date-time format) requested by
716724
the API consumer. Up to API project decision to keep it.
725+
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
726+
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
727+
example: "2023-07-03T12:27:08.312Z"
717728
subscriptionMaxEvents:
718729
type: integer
719730
description: |
@@ -743,7 +754,9 @@ components:
743754
- PLAIN
744755
- ACCESSTOKEN
745756
- REFRESHTOKEN
746-
description: "The type of the credential."
757+
description: |
758+
The type of the credential.
759+
Note: Type of the credential - MUST be set to ACCESSTOKEN for now
747760
discriminator:
748761
propertyName: credentialType
749762
mapping:
@@ -785,7 +798,7 @@ components:
785798
$ref: "#/components/schemas/Protocol"
786799
sink:
787800
type: string
788-
format: url
801+
format: uri
789802
description: |
790803
The address to which events shall be delivered using the selected
791804
protocol.
@@ -951,8 +964,12 @@ components:
951964
type: string
952965
format: date-time
953966
description: |
954-
Timestamp of when the occurrence happened. Must adhere to RFC 3339.
955-
example: "2018-04-05T17:31:00Z"
967+
Timestamp of when the occurrence happened.
968+
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/
969+
rfc3339#section-5.6) and must have time zone.
970+
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
971+
2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
972+
example: "2023-07-03T12:27:08.312Z"
956973

957974
EventTypeNotification:
958975
type: string

code/API_definitions/connectivity-insights.yaml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.3
22
info:
33
title: Connectivity Insights
4-
version: 0.5.0-rc.1
4+
version: 0.5.0
55
x-camara-commonalities: 0.5
66
description: |
77
With CAMARA Connectivity Insights, application developers gain essential
@@ -39,7 +39,7 @@ info:
3939
notifications of network quality.
4040
4141
Following diagram shows the interaction between different components
42-
![Sequence Diagram](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/main/documentation/API_documentation/ConnectivityInsights-SequenceDiagram.png)
42+
![Sequence Diagram](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r2.2/documentation/API_documentation/ConnectivityInsights-SequenceDiagram.png)
4343
4444
# Authorization and authentication
4545
@@ -72,7 +72,7 @@ externalDocs:
7272
url: https://github.com/camaraproject/ConnectivityInsights
7373

7474
servers:
75-
- url: "{apiRoot}/connectivity-insights/v0.5rc1"
75+
- url: "{apiRoot}/connectivity-insights/v0.5"
7676
variables:
7777
apiRoot:
7878
default: http://localhost:9091
@@ -173,6 +173,11 @@ components:
173173
current date and time is used and network data for the monitoring
174174
data aggregation is used to check network performance against the
175175
application profile defined.
176+
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/
177+
rfc3339#section-5.6) and must have time zone.
178+
Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows
179+
2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
180+
example: "2023-07-03T12:27:08.312Z"
176181

177182
NetworkQualityInsightResponse:
178183
type: object

0 commit comments

Comments
 (0)