Skip to content

Commit e9e92eb

Browse files
maheshc01maheshc01
committed
latest review comments addressed
1 parent 414f98d commit e9e92eb

6 files changed

+8
-22
lines changed

‎CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The API definition(s) are based on
5050
### Changed
5151
* Changes requested by Release Management for M4
5252

53-
**Full Changelog**: https://github.com/camaraproject/connectivityInsights/compare/r2.1...r2.2
53+
**Full Changelog**: https://github.com/camaraproject/connectivityInsights/compare/r1.2...r2.2
5454

5555
# r2.1
5656
## Release Notes

‎code/API_definitions/application-profiles.yaml

-14
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,6 @@ 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:

‎code/API_definitions/connectivity-insights-subscriptions.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -795,7 +795,7 @@ components:
795795
$ref: "#/components/schemas/Protocol"
796796
sink:
797797
type: string
798-
format: url
798+
format: uri
799799
description: |
800800
The address to which events shall be delivered using the selected
801801
protocol.

‎documentation/API_documentation/application-profiles-API-Readiness-Checklist.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Checklist for application-profiles v0.4.0 in r2.2
55
| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Reference information |
66
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
77
| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/application-profiles.yaml) |
8-
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Comm. release r2.2 |
9-
| 3 | Guidelines from ICM applied | O | M | M | M | Y | ICM release r2.2 |
8+
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Comm. release r2.3 |
9+
| 3 | Guidelines from ICM applied | O | M | M | M | Y | ICM release r2.3 |
1010
| 4 | API versioning convention applied | M | M | M | M | Y | |
1111
| 5 | API documentation | M | M | M | M | Y | inline in YAML |
1212
| 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/ConnectivityInsights-User-Story.md) |

‎documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md ‎documentation/API_documentation/connectivity-insights-API-Readiness-Checklist.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Checklist for connectivity-insights v0.5.0 in r2.2
55
| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Reference information |
66
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
77
| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/connectivity-insights.yaml) |
8-
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Comm. release r2.2 |
9-
| 3 | Guidelines from ICM applied | O | M | M | M | Y | ICM release r2.2 |
8+
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Comm. release r2.3 |
9+
| 3 | Guidelines from ICM applied | O | M | M | M | Y | ICM release r2.3 |
1010
| 4 | API versioning convention applied | M | M | M | M | Y | |
1111
| 5 | API documentation | M | M | M | M | Y | inline in YAML |
1212
| 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/ConnectivityInsights-User-Story.md) |

‎documentation/API_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md ‎documentation/API_documentation/connectivity-insights-subscriptions-API-Readiness-Checklist.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Checklist for connectivity-insights-subscriptions v0.5.0 in r2.2
55
| Nr | API release assets | alpha | release-candidate | initial<br>public | stable<br> public | Status | Reference information |
66
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----|
77
| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/connectivity-insights-subscriptions.yaml) |
8-
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Comm. release r2.2 |
9-
| 3 | Guidelines from ICM applied | O | M | M | M | Y | ICM release r2.2 |
8+
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Comm. release r2.3 |
9+
| 3 | Guidelines from ICM applied | O | M | M | M | Y | ICM release r2.3 |
1010
| 4 | API versioning convention applied | M | M | M | M | Y | |
1111
| 5 | API documentation | M | M | M | M | Y | inline in YAML |
1212
| 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/ConnectivityInsights-User-Story.md) |

0 commit comments

Comments
 (0)