diff --git a/CHANGELOG.md b/CHANGELOG.md index 0fe312b..46087d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # Changelog CAMARA Predictive Connectivity Data ## Table of Contents +- **[r1.2](#r12)** - **[r1.1](#r11)** **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.** @@ -10,6 +11,47 @@ The below sections record the changes for each API version in each release as fo * for subsequent release-candidate(s), only the delta to the previous release-candidate * for a public release, the consolidated changes since the previous public release +# r1.2 + +## Release Notes +This public release contains the definition and documentation of +* predictive-connectivity-data v0.1.0 + +The API definition(s) are based on +* Commonalities v0.6.0 +* Identity and Consent Management v0.4.0 + +## predictive-connectivity-data v0.1.0 + +This is the public release for the CAMARA Meta Release Fall25 release of the Predictive Connectivity Data API, version v0.1.0. It contains mainly alignments with the Commonalities v0.6.0. + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/PredictiveConnectivityData/blob/r1.2/code/API_definitions/predictive-connectivity-data.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.2/code/API_definitions/predictive-connectivity-data.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.2/code/API_definitions/predictive-connectivity-data.yaml) + +In the following there is the list of the modifications with respect to the previous release. + +### Added +* Add precision, height and signal strenght to the wip version by @albertoramosmonagas in https://github.com/camaraproject/PredictiveConnectivityData/pull/25 + +### Changed +* Alignment with Commonalities r3.3 by @albertoramosmonagas in https://github.com/camaraproject/PredictiveConnectivityData/pull/33 +* Define first WIP version of Predictive Connectivity Data API by @albertoramosmonagas in https://github.com/camaraproject/PredictiveConnectivityData/pull/20 +* Align commonalities with v0.6-rc1 by @albertoramosmonagas in https://github.com/camaraproject/PredictiveConnectivityData/pull/21 + +### Fixed +* N/A + +### Removed +* N/A + + ### New Contributors +* @eric-murray made their first contribution in https://github.com/camaraproject/PredictiveConnectivityData/pull/30 +* @albertoramosmonagas made their first contribution in https://github.com/camaraproject/PredictiveConnectivityData/pull/5 + +**Full Changelog**: https://github.com/camaraproject/PredictiveConnectivityData/commits/r1.2 + # r1.1 ## Release Notes @@ -22,7 +64,7 @@ The API definition(s) are based on ## predictive-connectivity-data v0.1rc1 -This is a release candidate for the CAMARA Meta Release Fall25 release of the Predictive Connectivity Data API, version v0.1rc1. It contains mainly alignments with the Commonalities v0.6.0-rc.1. +This is a pre-release candidate for the CAMARA Meta Release Fall25 release of the Predictive Connectivity Data API, version v0.1rc1. It contains mainly alignments with the Commonalities v0.6.0-rc.1. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/PredictiveConnectivityData/blob/r1.1/code/API_definitions/predictive-connectivity-data.yaml) diff --git a/README.md b/README.md index 492f1d7..09bf73d 100644 --- a/README.md +++ b/README.md @@ -28,16 +28,16 @@ Sandbox API Repository to describe, develop, document, and test the PredictiveCo **Version Control Notice:** This project undergoes active development with frequent updates to the main branch. No backward compatibility is guaranteed for any code in development branches, including main, until an official release is published. Code changes, including potential reversions, may occur between commits. We recommend using the latest official release version. -**The first pre-release is [r1.1](https://github.com/camaraproject/PredictiveConnectivityData/releases/tag/r1.1) and cointains the version 0.1.0.** - -* **predictive-connectivity-data v0.1.0-rc.1 (release candidate)** - [[YAML]](https://github.com/camaraproject/PredictiveConnectivityData/blob/r1.1/code/API_definitions/predictive-connectivity-data.yaml) - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.1/code/API_definitions/predictive-connectivity-data.yaml&nocors) - [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.1/code/API_definitions/predictive-connectivity-data.yaml) +The **NEW** latest public release of Predictive Connectivity Data is [r1.2](https://github.com/camaraproject/PredictiveConnectivityData/releases/tag/r1.2) and contains version 0.1.0. +- [[YAML]](https://github.com/camaraproject/PredictiveConnectivityData/blob/r1.2/code/API_definitions/predictive-connectivity-data.yaml) +- [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.2/code/API_definitions/predictive-connectivity-data.yaml&nocors) +- [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/PredictiveConnectivityData/r1.2/code/API_definitions/predictive-connectivity-data.yaml) +Other releases of this repository are available [here](https://github.com/camaraproject/PredictiveConnectivityData/releases) + For changes see [CHANGELOG.md](https://github.com/camaraproject/PredictiveConnectivityData/blob/main/CHANGELOG.md) ## Contributing diff --git a/code/API_definitions/predictive-connectivity-data.yaml b/code/API_definitions/predictive-connectivity-data.yaml index 922c106..7c59c2b 100644 --- a/code/API_definitions/predictive-connectivity-data.yaml +++ b/code/API_definitions/predictive-connectivity-data.yaml @@ -272,11 +272,19 @@ paths: $ref: '#/components/responses/Generic403' "410": $ref: "#/components/responses/Generic410" + security: + - {} + - notificationsBearerAuth: [] components: securitySchemes: openId: type: openIdConnect openIdConnectUrl: https://example.com/.well-known/openid-configuration + notificationsBearerAuth: + description: Bearer authentication for notifications + type: http + scheme: bearer + bearerFormat: '{$request.body#sinkCredential.credentialType}' headers: x-correlator: description: Correlation id for the different services. @@ -307,17 +315,13 @@ components: format: date-time description: >- Start date time. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) - and must have time zone. 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). + and must have time zone. endTime: type: string format: date-time description: >- End date time. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) - and must have time zone. 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). + and must have time zone. networkType: $ref: '#/components/schemas/NetworkType' precision: @@ -496,7 +500,6 @@ components: REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired. If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. - 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) example: "2023-07-03T12:27:08.312Z" accessTokenType: description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)). For the current version of the API the type MUST be set to `Bearer`. @@ -524,7 +527,6 @@ components: REQUIRED. An absolute (UTC) timestamp at which the token shall be considered expired. If the access token is a JWT and registered "exp" (Expiration Time) claim is present, the two expiry times should match. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. - 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) example: "2023-07-03T12:27:08.312Z" accessTokenType: description: REQUIRED. Type of the access token (See [OAuth 2.0](https://tools.ietf.org/html/rfc6749#section-7.1)). @@ -630,16 +632,14 @@ components: format: date-time description: >- Interval start time. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) - and must have time zone. 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) + and must have time zone. example: "2023-07-03T10:00:00Z" endTime: type: string format: date-time description: >- Interval end time. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) - and must have time zone. 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) + and must have time zone. example: "2023-07-03T11:00:00Z" cellConnectivityData: $ref: '#/components/schemas/CellConnectivityDataArray' diff --git a/code/Test_definitions/predictive-connectivity-data.feature b/code/Test_definitions/predictive-connectivity-data.feature index 6c5030d..dd555eb 100644 --- a/code/Test_definitions/predictive-connectivity-data.feature +++ b/code/Test_definitions/predictive-connectivity-data.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Predictive Connectivity Data API, v0.1 +Feature: CAMARA Predictive Connectivity Data API, v0.1.0 # Input to be provided by the implementation to the tester # # Implementation indications: diff --git a/documentation/API_documentation/predictive-connectivity-data-API-Readiness-Checklist.md b/documentation/API_documentation/predictive-connectivity-data-API-Readiness-Checklist.md index 59cabc9..7238021 100644 --- a/documentation/API_documentation/predictive-connectivity-data-API-Readiness-Checklist.md +++ b/documentation/API_documentation/predictive-connectivity-data-API-Readiness-Checklist.md @@ -1,23 +1,25 @@ # API Readiness Checklist -Checklist for predictive-connectivity-data v0.1.0-rc.1 in r1.1. +Checklist for predictive-connectivity-data v0.1.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/predictive-connectivity-data.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) | -| 4 | API versioning convention applied | M | M | M | M | Y | v0.1.0-rc.1 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3)*** | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) | +| 4 | API versioning convention applied | M | M | M | M | Y | v0.1.0 | | 5 | API documentation | M | M | M | M | Y | [inline in YAML](/code/API_definitions/predictive-connectivity-data.yaml) | | 6 | User stories | O | O | O | M | N | [link](/documentation/API_documentation/Predictive-Connectivity-Data_User_Story.mdd) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/predictive-connectivity-data.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_definitions/predictive-connectivity-data.feature) | | 9 | Test result statement | O | O | O | M | N | TBC | -| 10 | API release numbering convention applied | M | M | M | M | Y | r1.1 | +| 10 | API release numbering convention applied | M | M | M | M | Y | r1.2 | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | N | No | | 13 | API description (for marketing) | O | O | M | M | Y | [Wiki link](https://lf-camaraproject.atlassian.net/wiki/x/owAjBw) | +*** *The asynchronous response currently does not follow the CloudEvents delivery format as required by Commonalities r3.3. See Issue [#38](https://github.com/camaraproject/PredictiveConnectivityData/issues/38). This will be addressed post-Fall’25 and released as v0.2.0 to ensure full compliance* + To fill the checklist: - in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release. - in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.