From 45b483fd14ec03a64f56e19f8c9e2bb8d1d84604 Mon Sep 17 00:00:00 2001 From: "Chapalamadugu, Mahesh" Date: Mon, 26 Aug 2024 13:08:20 -0500 Subject: [PATCH 01/10] updates for issue #95 and #97 --- CHANGELOG.md | 50 +++++++------------ README.md | 37 ++++++++++---- .../API_definitions/application-profiles.yaml | 4 +- .../connectivity-insights-subscriptions.yaml | 32 ++++-------- .../connectivity-insights.yaml | 4 +- ...tivity-Insights-API-Readiness-Checklist.md | 2 +- ...s-Subscriptions-API-Readiness-Checklist.md | 2 +- documentation/API_documentation/README.MD | 1 - ...cation-profiles-API-Readiness-Checklist.md | 2 +- 9 files changed, 60 insertions(+), 74 deletions(-) delete mode 100644 documentation/API_documentation/README.MD diff --git a/CHANGELOG.md b/CHANGELOG.md index c667a3a..71521b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ NOTE: ## Table of contents -- **[r1.1 - rc](#r11---rc)** +- **[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.** @@ -17,7 +17,7 @@ respect to the previous pre-release * for a public API version, the consolidated changes since the release of the previous public API version -# r1.1 - rc +# r1.1 ## Release Notes This release contains the definition and documentation of @@ -26,13 +26,13 @@ This release contains the definition and documentation of * Application Profiles API v0.3.0 The API definition(s) are based on -* Commonalities v0.4.0-rc.2 -* Identity and Consent Management v0.2.0-rc.2 +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 -## Connectivity Insights API v0.4.0-rc.1 +## Connectivity Insights API v0.4.0 0.4.0-rc.1 is the first release of the API. The version is aligned with -Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2. +Commonalities 0.4.0 and Identity and Consent Management v0.2.0 - API definition **with inline documentation**: - View it on ReDoc: @@ -47,20 +47,13 @@ Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2. ### Added - - Gherkin `.feature` file in Test_definitions - - Implementation of ICM consent guidelines - - Addition of `x-camara-commonalities` object to YAML - - Documentation: added warning about use of `networkAccessIdentifier`, added User Story - +* n/a ### Changed - - Compliance with DeviceIdentifier schema - - Error model alignment, including device identifier-related errors - - Updated the API Readiness Checklist to the new format - -## Connectivity Insights Subscriptions API v0.4.0-rc.1 +* n/a +## Connectivity Insights Subscriptions API v0.4.0 0.4.0-rc.1 is the first release of the API. The version is aligned with -Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2. +Commonalities 0.4.0 and Identity and Consent Management v0.2.0 - API definition **with inline documentation**: - View it on ReDoc: @@ -75,22 +68,16 @@ Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2. ### Added - - Gherkin `.feature` file in Test_definitions - - Implementation of ICM consent guidelines - - Addition of `x-camara-commonalities` object to YAML - - Documentation: added warning about use of `networkAccessIdentifier`, added User Story - +* n/a ### Changed - - Compliance with DeviceIdentifier schema - - Error model alignment, including device identifier-related errors - - Updated the API Readiness Checklist to the new format +* n/a -## Application Profiles API 0.3.0-rc.1 +## Application Profiles API 0.3.0 0.3.0-rc.1 is the first release of the API. The version is aligned with -Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2. +Commonalities 0.4.0 and Identity and Consent Management v0.2.0 - API definition **with inline documentation**: - View it on ReDoc: @@ -103,12 +90,9 @@ Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2. - [application-profiles.yaml](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml) ### Added - -- Gherkin -`.feature` file in Test_definitions +* n/a ### Changed +* n/a -- Aligned the network monitoring KPIs to match with Quality on Demand CAMARA API. -- update the end points to make it more developer friendly based on the discussion in the API working group. -- Updated the API Readiness Checklist to the new format +**Full Changelog**: https://github.com/camaraproject/ConnectivityInsights/commits/r1.1 diff --git a/README.md b/README.md index 2b43d06..52d9fb6 100644 --- a/README.md +++ b/README.md @@ -10,20 +10,37 @@ Repository to describe, develop, document and test the Connectivity Insights API family ## Scope -* Service APIs for “Connectivity Insights” (see APIBacklog.md) -* It provides the customer with the ability to: +* Service APIs for “Connectivity Insights” (see APIBacklog.md) +* It provides the customer with the ability to: * 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. - * NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G. -* Describe, develop, document and test the APIs (with 1-2 Telcos) + * NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G. +* Describe, develop, document and test the APIs (with 1-2 Telcos) * Started: November 2023 -* Location: virtually +* Location: virtually ## Release Information - - - Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases - -For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectivityInsights/blob/main/CHANGELOG.md) + +* 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**. + +* **The latest public release of connectivity insights is [r1.1](https://github.com/camaraproject/ConnectivityInsights/tree/r1.1) with the following API definitions:** + + * **Connectivity Insights API v0.4.0** + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights.yaml&nocors) + [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights.yaml) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights.yaml) + + * **Connectivity Insights Subscriptions API v0.4.0** + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights-subscriptions.yaml&nocors) + [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights-subscriptions.yaml) + [OpenAPI](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights-subscriptions.yaml) + + * **Application Profiles API 0.3.0** + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml&nocors) + [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml) + + * Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases + * For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectivityInsights/blob/main/CHANGELOG.md) ## Contributing * Meetings diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml index 8752d61..1dd6abd 100644 --- a/code/API_definitions/application-profiles.yaml +++ b/code/API_definitions/application-profiles.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Connectivity Insights - Application Profiles - version: 0.3.0-rc.1 + version: 0.3.0 contact: email: sp-coi@lists.camaraproject.org license: @@ -28,7 +28,7 @@ info: x-camara-commonalities: 0.4.0 servers: - - url: "{apiRoot}/application-profiles/v0.3rc1" + - url: "{apiRoot}/application-profiles/v0.3" variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/connectivity-insights-subscriptions.yaml b/code/API_definitions/connectivity-insights-subscriptions.yaml index fe8678d..0979285 100644 --- a/code/API_definitions/connectivity-insights-subscriptions.yaml +++ b/code/API_definitions/connectivity-insights-subscriptions.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Connectivity Insights - version: 0.4.0-rc.1 + version: 0.4.0 contact: email: sp-coi@lists.camaraproject.org x-camara-commonalities: 0.4.0 @@ -74,7 +74,7 @@ externalDocs: url: https://github.com/camaraproject/ConnectivityInsights servers: - - url: "{apiRoot}/connectivity-insights-subscriptions/v0.4rc1/check-network-quality" + - url: "{apiRoot}/connectivity-insights-subscriptions/v0.4/check-network-quality" variables: apiRoot: default: http://localhost:9091 @@ -100,8 +100,7 @@ paths: - $ref: "#/components/parameters/x-correlator" security: - openId: - - connectivity-insights-subscriptions:org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-met:create - - connectivity-insights-subscriptions:org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-not-met:create + - connectivity-insights-subscriptions:org.camaraproject.connectivity-insights-subscriptions.v0.network-quality:create requestBody: content: @@ -779,7 +778,7 @@ components: type: array items: type: string - example: org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-met + example: org.camaraproject.connectivity-insights-subscriptions.v0.network-quality config: $ref: "#/components/schemas/Config" @@ -872,15 +871,13 @@ components: discriminator: propertyName: "type" mapping: - org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-met: - "#/components/schemas/EventNetworkQualityMet" - org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-not-met: - "#/components/schemas/EventNetworkQualityNotMet" + org.camaraproject.connectivity-insights-subscriptions.v0.network-quality: + "#/components/schemas/EventNetworkQuality" org.camaraproject.connectivityinsights.v0.eventSubscriptionEnds: "#/components/schemas/EventSubscriptionEnds" - EventNetworkQualityMet: - description: event structure for Network Quality met + EventNetworkQuality: + description: event structure for Network Quality allOf: - $ref: "#/components/schemas/CloudEvent" - type: object @@ -888,16 +885,6 @@ components: data: $ref: "#/components/schemas/NetworkQualityInsight" - EventNetworkQualityNotMet: - description: event structure for Network Quality not met - allOf: - - $ref: "#/components/schemas/CloudEvent" - - type: object - properties: - data: - $ref: "#/components/schemas/NetworkQualityInsight" - - EventSubscriptionEnds: description: event structure for event subscription ends allOf: @@ -950,8 +937,7 @@ components: event-type - Event triggered when an event-type event occurred subscription-ends: Event triggered when the subscription ends enum: - - org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-met - - org.camaraproject.connectivity-insights-subscriptions.v0.network-quality-not-met + - org.camaraproject.connectivity-insights-subscriptions.v0.network-quality - org.camaraproject.connectivity-insights-subscriptions.v0.subscription-ends ErrorInfo: type: object diff --git a/code/API_definitions/connectivity-insights.yaml b/code/API_definitions/connectivity-insights.yaml index 0fd7bce..13ab97f 100644 --- a/code/API_definitions/connectivity-insights.yaml +++ b/code/API_definitions/connectivity-insights.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Connectivity Insights - version: 0.4.0-rc.1 + version: 0.4.0 contact: email: sp-coi@lists.camaraproject.org x-camara-commonalities: 0.4.0 @@ -90,7 +90,7 @@ externalDocs: url: https://github.com/camaraproject/ConnectivityInsights servers: - - url: "{apiRoot}/connectivity-insights/v0.4rc1" + - url: "{apiRoot}/connectivity-insights/v0.4" variables: apiRoot: default: http://localhost:9091 diff --git a/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md b/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md index c3f1d64..1c55c6f 100644 --- a/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md +++ b/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # Connectivity Insights API Readiness minimum criteria checklist -Checklist for connectivity-insights v0.4.0-rc.1 +Checklist for connectivity-insights v0.4.0 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| diff --git a/documentation/API_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md index afeefda..4877009 100644 --- a/documentation/API_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # Connectivity Insights Subscriptions API Readiness minimum criteria checklist -Checklist for connectivity-insights-subscriptions v0.4.0-rc.1 +Checklist for connectivity-insights-subscriptions v0.4.0 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| diff --git a/documentation/API_documentation/README.MD b/documentation/API_documentation/README.MD deleted file mode 100644 index 37aa0ff..0000000 --- a/documentation/API_documentation/README.MD +++ /dev/null @@ -1 +0,0 @@ -This README.MD can be deleted when the first file is added to this directory. diff --git a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md index f184994..21e873a 100644 --- a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md +++ b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for application-profiles v0.3.0-rc.1 +Checklist for application-profiles v0.3.0 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| From 2736add4a2b16db8a436f81d707abb06c71f4e27 Mon Sep 17 00:00:00 2001 From: Mahesh <98130650+maheshc01@users.noreply.github.com> Date: Tue, 27 Aug 2024 11:03:48 -0500 Subject: [PATCH 02/10] Update CHANGELOG.md Co-authored-by: Kevin Smith --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 71521b3..16d2526 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,7 +31,7 @@ The API definition(s) are based on ## Connectivity Insights API v0.4.0 -0.4.0-rc.1 is the first release of the API. The version is aligned with +0.4.0 is the first release of the API. The version is aligned with Commonalities 0.4.0 and Identity and Consent Management v0.2.0 - API definition **with inline documentation**: From ab0ba640adc5494a0a430369f300a4d955bfe3bc Mon Sep 17 00:00:00 2001 From: Mahesh <98130650+maheshc01@users.noreply.github.com> Date: Tue, 27 Aug 2024 11:04:11 -0500 Subject: [PATCH 03/10] Update CHANGELOG.md Co-authored-by: Kevin Smith --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 16d2526..4bec0ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -52,7 +52,7 @@ Commonalities 0.4.0 and Identity and Consent Management v0.2.0 * n/a ## Connectivity Insights Subscriptions API v0.4.0 -0.4.0-rc.1 is the first release of the API. The version is aligned with +0.4.0 is the first release of the API. The version is aligned with Commonalities 0.4.0 and Identity and Consent Management v0.2.0 - API definition **with inline documentation**: From 4bcc2c60ecdc0ffa10902e6e67337ed15de1e982 Mon Sep 17 00:00:00 2001 From: Mahesh <98130650+maheshc01@users.noreply.github.com> Date: Tue, 27 Aug 2024 11:04:24 -0500 Subject: [PATCH 04/10] Update CHANGELOG.md Co-authored-by: Kevin Smith --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4bec0ba..304a188 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -76,7 +76,7 @@ Commonalities 0.4.0 and Identity and Consent Management v0.2.0 -0.3.0-rc.1 is the first release of the API. The version is aligned with +0.3.0 is the first release of the API. The version is aligned with Commonalities 0.4.0 and Identity and Consent Management v0.2.0 - API definition **with inline documentation**: From e6ddf621b5ce560be25434176a965c572bf8736d Mon Sep 17 00:00:00 2001 From: "Chapalamadugu, Mahesh" Date: Tue, 27 Aug 2024 16:33:16 -0500 Subject: [PATCH 05/10] updated the release from r1.1 to 1.2 --- CHANGELOG.md | 38 +++++++++++++++++++ README.md | 20 +++++----- ...tivity-Insights-API-Readiness-Checklist.md | 2 +- ...s-Subscriptions-API-Readiness-Checklist.md | 2 +- ...cation-profiles-API-Readiness-Checklist.md | 2 +- 5 files changed, 51 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 304a188..b954504 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ NOTE: ## 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.** @@ -17,6 +18,43 @@ respect to the previous pre-release * for a public API version, the consolidated changes since the release of the previous public API version +# r1.2 +## Release Notes + +This release contains the definition and documentation of +* Connectivity Insights API v0.4.0 +* Connectivity Insights Subscriptions API v0.4.0 +* Application Profiles API v0.3.0 + +The API definition(s) are based on +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 + +* **r1.2 release of connectivity insights has the following API definitions:** + + * **Connectivity Insights API v0.4.0** + [[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) + [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml) + + * **Connectivity Insights Subscriptions API v0.4.0** + [[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) + [[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) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights-subscriptions.yaml) + + * **Application Profiles API 0.3.0** + [[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) + [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml) + +### Added +* n/a +### Changed +* n/a + +**Full Changelog**: https://github.com/camaraproject/connectivityInsights/compare/r1.1...r1.2 + + # r1.1 ## Release Notes diff --git a/README.md b/README.md index 52d9fb6..96c2d4d 100644 --- a/README.md +++ b/README.md @@ -22,22 +22,22 @@ Repository to describe, develop, document and test the Connectivity Insights API * 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**. -* **The latest public release of connectivity insights is [r1.1](https://github.com/camaraproject/ConnectivityInsights/tree/r1.1) with the following API definitions:** +* **The latest public release of connectivity insights is [r1.2](https://github.com/camaraproject/ConnectivityInsights/tree/r1.2) with the following API definitions:** * **Connectivity Insights API v0.4.0** - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights.yaml&nocors) - [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights.yaml) - [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.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/connectivity-insights.yaml&nocors) + [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml) * **Connectivity Insights Subscriptions API v0.4.0** - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights-subscriptions.yaml&nocors) - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights-subscriptions.yaml) - [OpenAPI](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/connectivity-insights-subscriptions.yaml) + [[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) + [[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) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights-subscriptions.yaml) * **Application Profiles API 0.3.0** - [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml&nocors) - [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml) - [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.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) + [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml) + [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml) * Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases * For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectivityInsights/blob/main/CHANGELOG.md) diff --git a/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md b/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md index 1c55c6f..097c367 100644 --- a/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md +++ b/documentation/API_documentation/Connectivity-Insights-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # Connectivity Insights API Readiness minimum criteria checklist -Checklist for connectivity-insights v0.4.0 in r1.1 +Checklist for connectivity-insights v0.4.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| diff --git a/documentation/API_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md index 4877009..0686d71 100644 --- a/documentation/API_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/Connectivity-Insights-Subscriptions-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # Connectivity Insights Subscriptions API Readiness minimum criteria checklist -Checklist for connectivity-insights-subscriptions v0.4.0 in r1.1 +Checklist for connectivity-insights-subscriptions v0.4.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| diff --git a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md index 21e873a..8b22e35 100644 --- a/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md +++ b/documentation/API_documentation/application-profiles-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for application-profiles v0.3.0 in r1.1 +Checklist for application-profiles v0.3.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| From 4d6d9dfb3fdd079edc63b341656aa409bebcea7d Mon Sep 17 00:00:00 2001 From: "Chapalamadugu, Mahesh" Date: Wed, 28 Aug 2024 11:13:22 -0500 Subject: [PATCH 06/10] fix for issue #99 and #100 --- CHANGELOG.md | 76 +++++++++++++++++++++++++++++++--------------------- 1 file changed, 46 insertions(+), 30 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b954504..e3e1b40 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ NOTE: ## Table of contents - **[r1.2](#r12)** -- **[r1.1](#r11)** +- **[r1.1 - rc](#r11---rc)** **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.** @@ -22,9 +22,9 @@ previous public API version ## Release Notes This release contains the definition and documentation of -* Connectivity Insights API v0.4.0 -* Connectivity Insights Subscriptions API v0.4.0 -* Application Profiles API v0.3.0 +* connectivity-insights v0.4.0 +* connectivity-insights-subscriptions v0.4.0 +* application-profiles v0.3.0 The API definition(s) are based on * Commonalities v0.4.0 @@ -32,17 +32,17 @@ The API definition(s) are based on * **r1.2 release of connectivity insights has the following API definitions:** - * **Connectivity Insights API v0.4.0** + * **connectivity-insights v0.4.0** [[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) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml) [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights.yaml) - * **Connectivity Insights Subscriptions API v0.4.0** + * **connectivity-insights-subscriptions v0.4.0** [[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) [[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) [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/connectivity-insights-subscriptions.yaml) - * **Application Profiles API 0.3.0** + * **application-profiles v0.3.0** [[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) [[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml) [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml) @@ -55,22 +55,22 @@ The API definition(s) are based on **Full Changelog**: https://github.com/camaraproject/connectivityInsights/compare/r1.1...r1.2 -# r1.1 +# r1.1 - rc ## Release Notes This release contains the definition and documentation of -* Connectivity Insights API v0.4.0 -* Connectivity Insights Subscriptions API v0.4.0 -* Application Profiles API v0.3.0 +* connectivity-insights v0.4.0-rc.1 +* connectivity-insights-subscriptions v0.4.0-rc.1 +* application-profiles v0.3.0-rc.1 The API definition(s) are based on -* Commonalities v0.4.0 -* Identity and Consent Management v0.2.0 +* Commonalities v0.4.0-rc.2 +* Identity and Consent Management v0.2.0-rc.2 -## Connectivity Insights API v0.4.0 +## connectivity-insights v0.4.0-rc.1 -0.4.0 is the first release of the API. The version is aligned with -Commonalities 0.4.0 and Identity and Consent Management v0.2.0 +0.4.0-rc.1 is the first release of the API. The version is aligned with +Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2. - API definition **with inline documentation**: - View it on ReDoc: @@ -85,13 +85,20 @@ Commonalities 0.4.0 and Identity and Consent Management v0.2.0 ### Added -* n/a + - Gherkin `.feature` file in Test_definitions + - Implementation of ICM consent guidelines + - Addition of `x-camara-commonalities` object to YAML + - Documentation: added warning about use of `networkAccessIdentifier`, added User Story + ### Changed -* n/a -## Connectivity Insights Subscriptions API v0.4.0 + - Compliance with DeviceIdentifier schema + - Error model alignment, including device identifier-related errors + - Updated the API Readiness Checklist to the new format + +## connectivity-insights-subscriptions v0.4.0-rc.1 -0.4.0 is the first release of the API. The version is aligned with -Commonalities 0.4.0 and Identity and Consent Management v0.2.0 +0.4.0-rc.1 is the first release of the API. The version is aligned with +Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2. - API definition **with inline documentation**: - View it on ReDoc: @@ -106,16 +113,20 @@ Commonalities 0.4.0 and Identity and Consent Management v0.2.0 ### Added -* n/a -### Changed -* n/a - -## Application Profiles API 0.3.0 + - Gherkin `.feature` file in Test_definitions + - Implementation of ICM consent guidelines + - Addition of `x-camara-commonalities` object to YAML + - Documentation: added warning about use of `networkAccessIdentifier`, added User Story +### Changed + - Compliance with DeviceIdentifier schema + - Error model alignment, including device identifier-related errors + - Updated the API Readiness Checklist to the new format +## application-profiles 0.3.0-rc.1 -0.3.0 is the first release of the API. The version is aligned with -Commonalities 0.4.0 and Identity and Consent Management v0.2.0 +0.3.0-rc.1 is the first release of the API. The version is aligned with +Commonalities 0.4.0-rc.2 and Identity and Consent Management v0.2.0-rc.2. - API definition **with inline documentation**: - View it on ReDoc: @@ -128,9 +139,14 @@ Commonalities 0.4.0 and Identity and Consent Management v0.2.0 - [application-profiles.yaml](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.1/code/API_definitions/application-profiles.yaml) ### Added -* n/a + +- Gherkin +`.feature` file in Test_definitions ### Changed -* n/a + +- Aligned the network monitoring KPIs to match with Quality on Demand CAMARA API. +- update the end points to make it more developer friendly based on the discussion in the API working group. +- Updated the API Readiness Checklist to the new format **Full Changelog**: https://github.com/camaraproject/ConnectivityInsights/commits/r1.1 From 3d1d0a3e8ace1a4cf77c75cb46b6794d0bc73fea Mon Sep 17 00:00:00 2001 From: Mahesh <98130650+maheshc01@users.noreply.github.com> Date: Fri, 30 Aug 2024 09:28:25 -0500 Subject: [PATCH 07/10] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e3e1b40..894d15d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -52,7 +52,7 @@ The API definition(s) are based on ### Changed * n/a -**Full Changelog**: https://github.com/camaraproject/connectivityInsights/compare/r1.1...r1.2 +**Full Changelog**: https://github.com/camaraproject/connectivityInsights/commits/r1.2 # r1.1 - rc From bf39a2ae019161dbeae84db47739c91db370779a Mon Sep 17 00:00:00 2001 From: "Chapalamadugu, Mahesh" Date: Fri, 30 Aug 2024 09:47:54 -0500 Subject: [PATCH 08/10] update to readme based on review comments and removed contact info in the 3 yaml files. --- README.md | 5 +++-- code/API_definitions/application-profiles.yaml | 2 -- .../API_definitions/connectivity-insights-subscriptions.yaml | 2 -- code/API_definitions/connectivity-insights.yaml | 2 -- 4 files changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 96c2d4d..934f1c2 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Repository to describe, develop, document and test the Connectivity Insights API * 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**. -* **The latest public release of connectivity insights is [r1.2](https://github.com/camaraproject/ConnectivityInsights/tree/r1.2) with the following API definitions:** +* **[r1.2](https://github.com/camaraproject/ConnectivityInsights/tree/r1.2) is the first public release of connectivity insights with the following API definitions:** * **Connectivity Insights API v0.4.0** [[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) @@ -40,7 +40,8 @@ Repository to describe, develop, document and test the Connectivity Insights API [[OpenAPI]](https://raw.githubusercontent.com/camaraproject/ConnectivityInsights/r1.2/code/API_definitions/application-profiles.yaml) * Pre-releases of this sub project are available in https://github.com/camaraproject/ConnectivityInsights/releases - * For changes see [CHANGELOG.md](https://github.com/camaraproject/ConnectivityInsights/blob/main/CHANGELOG.md) + + * 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. ## Contributing * Meetings diff --git a/code/API_definitions/application-profiles.yaml b/code/API_definitions/application-profiles.yaml index 1dd6abd..63bcd1b 100644 --- a/code/API_definitions/application-profiles.yaml +++ b/code/API_definitions/application-profiles.yaml @@ -2,8 +2,6 @@ openapi: 3.0.3 info: title: Connectivity Insights - Application Profiles version: 0.3.0 - contact: - email: sp-coi@lists.camaraproject.org license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html diff --git a/code/API_definitions/connectivity-insights-subscriptions.yaml b/code/API_definitions/connectivity-insights-subscriptions.yaml index 0979285..de7976b 100644 --- a/code/API_definitions/connectivity-insights-subscriptions.yaml +++ b/code/API_definitions/connectivity-insights-subscriptions.yaml @@ -2,8 +2,6 @@ openapi: 3.0.3 info: title: Connectivity Insights version: 0.4.0 - contact: - email: sp-coi@lists.camaraproject.org x-camara-commonalities: 0.4.0 description: | With CAMARA Connectivity Insights, application developers gain essential diff --git a/code/API_definitions/connectivity-insights.yaml b/code/API_definitions/connectivity-insights.yaml index 13ab97f..8dcb06b 100644 --- a/code/API_definitions/connectivity-insights.yaml +++ b/code/API_definitions/connectivity-insights.yaml @@ -2,8 +2,6 @@ openapi: 3.0.3 info: title: Connectivity Insights version: 0.4.0 - contact: - email: sp-coi@lists.camaraproject.org x-camara-commonalities: 0.4.0 description: | With CAMARA Connectivity Insights, application developers gain essential From 3180b689e89dc1d19245f30b5f24960744be89f4 Mon Sep 17 00:00:00 2001 From: Mahesh <98130650+maheshc01@users.noreply.github.com> Date: Fri, 6 Sep 2024 14:53:30 -0500 Subject: [PATCH 09/10] Update README.md Co-authored-by: Herbert Damker --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 934f1c2..8324cf9 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ Repository to describe, develop, document and test the Connectivity Insights API * NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G. * Describe, develop, document and test the APIs (with 1-2 Telcos) * Started: November 2023 -* Location: virtually ## Release Information From e46f07bfcb46d3e4b392b6fc91aae98d7bc4fd26 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Mon, 9 Sep 2024 19:39:58 +0200 Subject: [PATCH 10/10] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 894d15d..0d2eb33 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,7 +30,7 @@ The API definition(s) are based on * Commonalities v0.4.0 * Identity and Consent Management v0.2.0 -* **r1.2 release of connectivity insights has the following API definitions:** +* **r1.2 release of ConnectivityInsights has the following API definitions:** * **connectivity-insights v0.4.0** [[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)