From a25879f9160e235a5bbc3c4cb096983704b50973 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 25 Aug 2025 17:59:27 +0200 Subject: [PATCH 01/20] M4 0.10.0 OAS --- code/API_definitions/traffic-influence.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/traffic-influence.yaml b/code/API_definitions/traffic-influence.yaml index 72ec9b7..74a10f1 100644 --- a/code/API_definitions/traffic-influence.yaml +++ b/code/API_definitions/traffic-influence.yaml @@ -329,7 +329,7 @@ info: error response if it is explicitly documented in the API. # FAQ's (FAQs will be added in a later version of the documentation) - version: wip + version: 0.10.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -341,7 +341,7 @@ externalDocs: # Servers # ############################################################################ servers: - - url: "{apiRoot}/traffic-influence/vwip" + - url: "{apiRoot}/traffic-influence/v0.10" variables: apiRoot: default: http://localhost:9091 From 32fd42e3f20d99f0bea45aeecadde2c3d7e6e272 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 25 Aug 2025 18:01:59 +0200 Subject: [PATCH 02/20] M4 0.10.0 test --- .../traffic-influence-postTrafficInfluence.feature | 8 ++++---- .../traffic-influence-postTrafficInfluenceDevice.feature | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/code/Test_definitions/traffic-influence-postTrafficInfluence.feature b/code/Test_definitions/traffic-influence-postTrafficInfluence.feature index cba0fdf..367d59d 100644 --- a/code/Test_definitions/traffic-influence-postTrafficInfluence.feature +++ b/code/Test_definitions/traffic-influence-postTrafficInfluence.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Traffic Influence API, vwip - Operation postTrafficInfluence and patchTrafficInfluence and getAllTrafficInfluences and deleteTrafficInfluence +Feature: CAMARA Traffic Influence API, v0.10.0 - Operation postTrafficInfluence and patchTrafficInfluence and getAllTrafficInfluences and deleteTrafficInfluence # Input to be provided by the implementation to the tester # # Implementation indications: @@ -6,10 +6,10 @@ Feature: CAMARA Traffic Influence API, vwip - Operation postTrafficInfluence and # Testing assets: # * The optimal routing must be activated for any device # - # References to OAS spec schemas refer to schemas specifies in traffic-influence.yaml, version wip + # References to OAS spec schemas refer to schemas specifies in traffic-influence.yaml, version 0.10.0 Background: Common traffic-influences setup - Given the path "/traffic-influence/vwip/traffic-influences" + Given the path "/traffic-influence/v0.10/traffic-influences" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" @@ -103,4 +103,4 @@ Feature: CAMARA Traffic Influence API, vwip - Operation postTrafficInfluence and And within a limited period of time I should receive a callback at "/components/schemas/NotificationSink/sink" And the callback body is compliant with the OAS schema at "/components/callbacks/onTrafficInfluenceChanged" with "x-correlator" having the same value as the request header "x-correlator" And the callback carries the information defined in "/components/schemas/CloudEvent" - And "/components/schemas/CloudEvent" in the callback should contain the parameter ("$.state") set according to the result + And "/components/schemas/CloudEvent" in the callback should contain the parameter ("$.state") set according to the result \ No newline at end of file diff --git a/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature b/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature index 0c45d36..dec8782 100644 --- a/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature +++ b/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Traffic Influence API, vwip - Operation postTrafficInfluenceDevice +Feature: CAMARA Traffic Influence API, v0.10.0 - Operation postTrafficInfluenceDevice # Input to be provided by the implementation to the tester # # Implementation indications: @@ -6,10 +6,10 @@ Feature: CAMARA Traffic Influence API, vwip - Operation postTrafficInfluenceDevi # Testing assets: # * The optimal routing for a device must be activated # - # References to OAS spec schemas refer to schemas specifies in traffic-influence.yaml, version wip + # References to OAS spec schemas refer to schemas specifies in traffic-influence.yaml, version 0.10.0 Background: Common traffic-influence-devices setup - Given the path "/traffic-influence/vwip/traffic-influence-devices" + Given the path "/traffic-influence/v0.10/traffic-influence-devices" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" @@ -98,4 +98,4 @@ Feature: CAMARA Traffic Influence API, vwip - Operation postTrafficInfluenceDevi And within a limited period of time I should receive a callback at "/components/schemas/NotificationSink/sink" And the callback body is compliant with the OAS schema at "/components/callbacks/onTrafficInfluenceChanged" with "x-correlator" having the same value as the request header "x-correlator" And the callback carries the information defined in "/components/schemas/CloudEvent" with the parameter ("$.state") set accordingly to the result - And if the device in the authorization token included multiple identifier, only the one used by the network is returned + And if the device in the authorization token included multiple identifier, only the one used by the network is returned \ No newline at end of file From 03eafe2ebdc5fc37365514daf1e0b3ee39a6b6c5 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 25 Aug 2025 18:03:49 +0200 Subject: [PATCH 03/20] M4 0.10.0 RCL --- .../traffic-influence-API-Readiness-Checklist.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md b/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md index b200044..c9691c0 100644 --- a/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md +++ b/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md @@ -1,19 +1,19 @@ # API Readiness Checklist -Checklist for traffic-influence v0.10.0-rc.1 in r.1.2 +Checklist for traffic-influence v0.10.0 in r.1.3 | 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/traffic-influence.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.10.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.10.0 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/traffic-influence-user-story-use-case-1.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [Device](/code/Test_definitions/traffic-influence-device-test.feature), [Every User](/code/Test_definitions/traffic-influence-test.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | Y | r1.2 | +| 10 | API release numbering convention applied | M | M | M | M | Y | r1.3 | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public-release was certified | O | O | O | M | N | | | 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/d4JlBQ) | @@ -29,3 +29,4 @@ To fill the checklist: Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine). + From 00ee9f4a1bafee911d3746f79699dea0580782b9 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 25 Aug 2025 18:19:33 +0200 Subject: [PATCH 04/20] M4 0.10.0 readme and changelog --- CHANGELOG.md | 60 ++++++++++++++++++++++++++++++++++++++++++++-------- README.md | 6 +++++- 2 files changed, 56 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b83510c..84d0511 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## Table of Contents +- **[r1.3](#r13)** - **[r1.2](#r12)** - **[r1.1](#r11)** @@ -15,6 +16,51 @@ 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.3 + +## Release Notes + +This pre-release contains the definition and documentation of: +* traffic-influence v0.10.0 + +The API definition(s) are based on +* Commonalities v0.6.0 +* Identity and Consent Management v0.4.0 + +## traffic-influence v0.10.0 +This is a public release for the CAMARA Traffic Influence API. This version provides the ability to influence the traffic flow from the user device toward the Edge instance of the Application providing the optimal routing. +The traffic can be influenced even when the user device moves to a different geographical location to always get the optimal routing toward the nearer instance of an Application.. + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/TrafficInfluence/blob/r1.3/code/API_definitions/traffic-influence.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/TrafficInfluence/r1.3/code/API_definitions/traffic-influence.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/TrafficInfluence/r1.3/code/API_definitions/traffic-influence.yaml) + +## Please note: + +- This pre-release contains a release-candidate API version, there are bug fixes to be expected and incompatible changes in upcoming versions +- The release is suitable for implementers, but it is not recommended to use the API with customers in productive environments +- The release scope is defined here: https://github.com/camaraproject/TrafficInfluence/issues/14 + +### Added +* Support for the following use cases: https://github.com/camaraproject/TrafficInfluence/discussions/15 + +### Changed +* x-correlator update: https://github.com/camaraproject/TrafficInfluence/pull/49 +* Alignment with the CAMARA Error codes: https://github.com/camaraproject/TrafficInfluence/pull/53 +* Updated the name of the test file to be coherent with the operationId: https://github.com/camaraproject/TrafficInfluence/pull/53 +* ErrorInfo scheme updated: https://github.com/camaraproject/TrafficInfluence/pull/65 + +### Fixed +* Backslash \ is not standard markdown syntax for paragraph: https://github.com/camaraproject/TrafficInfluence/pull/53 +* info.description reordering: https://github.com/camaraproject/TrafficInfluence/pull/62 +* Path in Background section: https://github.com/camaraproject/TrafficInfluence/pull/62 +* DeviceResponse description updated: https://github.com/camaraproject/TrafficInfluence/pull/65 + +### Removed + +**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/compare/r1.1...r1.3 + # r1.2 ## Release Notes @@ -28,7 +74,7 @@ The API definition(s) are based on ## traffic-influence v0.10.0-rc.1 This is the release candidate for the CAMARA Traffic Influence API. This version provides the ability to influence the traffic flow from the user device toward the Edge instance of the Application providing the optimal routing. -The traffic can be influencend even when the user device moves to a different geographical location to always get the optimal routing toward the nearer instance of an Application.. +The traffic can be influenced even when the user device moves to a different geographical location to always get the optimal routing toward the nearer instance of an Application.. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/TrafficInfluence/blob/r1.2/code/API_definitions/traffic-influence.yaml) @@ -44,19 +90,15 @@ The traffic can be influencend even when the user device moves to a different ge ### Added ### Changed - -* Renamed operations: https://github.com/camaraproject/EnergyFootprintNotification/pull/83 -* Changed OAuth2 with OpenId: https://github.com/camaraproject/EnergyFootprintNotification/pull/83 -* Updated the name of the test file to be coherent with the operationId: https://github.com/camaraproject/EnergyFootprintNotification/pull/83 * x-correlator update: https://github.com/camaraproject/TrafficInfluence/pull/49 * Alignment with the CAMARA Error codes: https://github.com/camaraproject/TrafficInfluence/pull/53 * Updated the name of the test file to be coherent with the operationId: https://github.com/camaraproject/TrafficInfluence/pull/53 ### Fixed - +* Backslash \ is not standard markdown syntax for paragraph: https://github.com/camaraproject/TrafficInfluence/pull/53 ### Removed -**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1...r1.2 +**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/compare/r1.1...r1.2 # r1.1 @@ -71,7 +113,7 @@ The API definition(s) are based on ## traffic-influence v0.9.0-alpha.1 This is an alpha release of the CAMARA Traffic Influence API v0.9.0. This version provides the ability to influence the traffic flow from the user device toward the Edge instance of the Application providing the optimal routing. -The traffic can be influencend even when the user device moves to a different geographical location to always get the optimal routing toward the nearer instance of an Application.. +The traffic can be influenced even when the user device moves to a different geographical location to always get the optimal routing toward the nearer instance of an Application.. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/TrafficInfluence/blob/r1.1/code/API_definitions/traffic-influence.yaml) @@ -95,4 +137,4 @@ The traffic can be influencend even when the user device moves to a different ge * @nicolacdnll * @Kevsy -**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 +**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 \ No newline at end of file diff --git a/README.md b/README.md index c066130..c6af3a6 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,11 @@ Sandbox API Repository to describe, develop, document, and test the TrafficInflu ## Release Information 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**. -* **NEW**: Pre-release [r1.2](https://github.com/camaraproject/TrafficInfluence/releases/tag/r1.2). with traffic-influence v0.10.0-rc.1 is available. +* `NEW`: The latest public release is [r1.3](https://github.com/camaraproject/TrafficInfluence/releases/tag/r1.3) with traffic-influence v0.10.0 +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/TrafficInfluence/blob/r1.3/code/API_definitions/traffic-influence.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/TrafficInfluence/r1.3/code/API_definitions/traffic-influence.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/TrafficInfluence/r1.3/code/API_definitions/traffic-influence.yaml) **Previous releases of the TrafficInfluence API available in [EdgeCloud](https://github.com/camaraproject/EdgeCloud).** From 241d53921645908d828e401f837f5dae92424717 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:49:28 +0200 Subject: [PATCH 05/20] Full Changelog URL --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 84d0511..6247f95 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -59,7 +59,7 @@ The traffic can be influenced even when the user device moves to a different geo ### Removed -**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/compare/r1.1...r1.3 +**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commit/r1.3 # r1.2 @@ -137,4 +137,4 @@ The traffic can be influenced even when the user device moves to a different geo * @nicolacdnll * @Kevsy -**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 \ No newline at end of file +**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 From 62082d24ee1e2062cac073b9731ee95342b49d6e Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 16:08:57 +0200 Subject: [PATCH 06/20] Update CHANGELOG.md - commits https://github.com/camaraproject/TrafficInfluence/pull/68#discussion_r2314047404 --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6247f95..b671186 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -59,7 +59,7 @@ The traffic can be influenced even when the user device moves to a different geo ### Removed -**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commit/r1.3 +**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.3 # r1.2 From ce22e10a536f7e93cfadd5b65a50c5e001d34eec Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 2 Sep 2025 15:24:04 +0200 Subject: [PATCH 07/20] 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 b671186..d74b757 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,7 +20,7 @@ The below sections record the changes for each API version in each release as fo ## Release Notes -This pre-release contains the definition and documentation of: +This public release contains the definition and documentation of: * traffic-influence v0.10.0 The API definition(s) are based on From fa1e7df10bfc9692e4e0d16e88ae28ee10697e33 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 2 Sep 2025 15:24:20 +0200 Subject: [PATCH 08/20] Update CHANGELOG.md Co-authored-by: Kevin Smith --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d74b757..b511e71 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -38,7 +38,6 @@ The traffic can be influenced even when the user device moves to a different geo ## Please note: -- This pre-release contains a release-candidate API version, there are bug fixes to be expected and incompatible changes in upcoming versions - The release is suitable for implementers, but it is not recommended to use the API with customers in productive environments - The release scope is defined here: https://github.com/camaraproject/TrafficInfluence/issues/14 From 2bde078a5133faca2902fdef180adf941ab752b2 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 3 Sep 2025 15:00:51 +0200 Subject: [PATCH 09/20] 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 b511e71..39dc352 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,7 +29,7 @@ The API definition(s) are based on ## traffic-influence v0.10.0 This is a public release for the CAMARA Traffic Influence API. This version provides the ability to influence the traffic flow from the user device toward the Edge instance of the Application providing the optimal routing. -The traffic can be influenced even when the user device moves to a different geographical location to always get the optimal routing toward the nearer instance of an Application.. +The traffic can be influenced even when the user device moves to a different geographical location to always get the optimal routing toward the nearer instance of an Application. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/TrafficInfluence/blob/r1.3/code/API_definitions/traffic-influence.yaml) From 7660fd807e96ced562171978fb992d153cb8a44b Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 3 Sep 2025 15:01:29 +0200 Subject: [PATCH 10/20] Update code/Test_definitions/traffic-influence-postTrafficInfluence.feature Co-authored-by: Herbert Damker --- .../traffic-influence-postTrafficInfluence.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/traffic-influence-postTrafficInfluence.feature b/code/Test_definitions/traffic-influence-postTrafficInfluence.feature index 367d59d..011a4a9 100644 --- a/code/Test_definitions/traffic-influence-postTrafficInfluence.feature +++ b/code/Test_definitions/traffic-influence-postTrafficInfluence.feature @@ -6,7 +6,7 @@ Feature: CAMARA Traffic Influence API, v0.10.0 - Operation postTrafficInfluence # Testing assets: # * The optimal routing must be activated for any device # - # References to OAS spec schemas refer to schemas specifies in traffic-influence.yaml, version 0.10.0 + # References to OAS spec schemas refer to schemas specifies in traffic-influence.yaml Background: Common traffic-influences setup Given the path "/traffic-influence/v0.10/traffic-influences" From a5da0be939bbff88cd1503acddb5841abe72f6eb Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 3 Sep 2025 15:01:44 +0200 Subject: [PATCH 11/20] Update code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature Co-authored-by: Herbert Damker --- .../traffic-influence-postTrafficInfluenceDevice.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature b/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature index dec8782..36c4bb4 100644 --- a/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature +++ b/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature @@ -6,7 +6,7 @@ Feature: CAMARA Traffic Influence API, v0.10.0 - Operation postTrafficInfluenceD # Testing assets: # * The optimal routing for a device must be activated # - # References to OAS spec schemas refer to schemas specifies in traffic-influence.yaml, version 0.10.0 + # References to OAS spec schemas refer to schemas specifies in traffic-influence.yaml Background: Common traffic-influence-devices setup Given the path "/traffic-influence/v0.10/traffic-influence-devices" From 0037d0b9c53ee226a5ad0d30ac5d033cf96dd077 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Thu, 4 Sep 2025 09:06:06 +0200 Subject: [PATCH 12/20] note for rel 1.3 https://github.com/camaraproject/TrafficInfluence/pull/68#discussion_r2318762934 --- CHANGELOG.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 39dc352..36bf226 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,6 +40,7 @@ The traffic can be influenced even when the user device moves to a different geo - The release is suitable for implementers, but it is not recommended to use the API with customers in productive environments - The release scope is defined here: https://github.com/camaraproject/TrafficInfluence/issues/14 +- This is the first public release of the API, the modification reported below ("Changed" and "Fixed" sections) are with respect to v0.10.0-rc.1 in r1.2. ### Added * Support for the following use cases: https://github.com/camaraproject/TrafficInfluence/discussions/15 @@ -64,7 +65,7 @@ The traffic can be influenced even when the user device moves to a different geo ## Release Notes -This pre-release contains the definition and documentation of: +This release contains the definition and documentation of: * traffic-influence v0.10.0-rc.1 The API definition(s) are based on @@ -136,4 +137,4 @@ The traffic can be influenced even when the user device moves to a different geo * @nicolacdnll * @Kevsy -**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 +**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 \ No newline at end of file From 17df308b0049a9f97e5ccbd840a1bb4509fd136b Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Thu, 4 Sep 2025 09:19:02 +0200 Subject: [PATCH 13/20] test file names https://github.com/camaraproject/TrafficInfluence/pull/68#discussion_r2318831402 --- .../traffic-influence-API-Readiness-Checklist.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md b/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md index c9691c0..be99d45 100644 --- a/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md +++ b/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md @@ -1,19 +1,19 @@ # API Readiness Checklist -Checklist for traffic-influence v0.10.0 in r.1.3 +Checklist for traffic-influence v0.10.0-rc.1 in r.1.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/traffic-influence.yaml) | -| 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.10.0 | +| 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.10.0-rc.1 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/traffic-influence-user-story-use-case-1.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [Device](/code/Test_definitions/traffic-influence-device-test.feature), [Every User](/code/Test_definitions/traffic-influence-test.feature) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [Device](/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature), [Every User](/code/Test_definitions/traffic-influence-postTrafficInfluence.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | Y | r1.3 | +| 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 | | | 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/d4JlBQ) | @@ -29,4 +29,3 @@ To fill the checklist: Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine). - From 4f1420033df38e323600b95754b979c31b455659 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 9 Sep 2025 15:53:33 +0200 Subject: [PATCH 14/20] M4 release v0.10.0 --- .../traffic-influence-API-Readiness-Checklist.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md b/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md index be99d45..79b0c03 100644 --- a/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md +++ b/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md @@ -1,19 +1,19 @@ # API Readiness Checklist -Checklist for traffic-influence v0.10.0-rc.1 in r.1.2 +Checklist for traffic-influence v0.10.0 in r.1.3 | 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/traffic-influence.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.10.0-rc.1 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r332](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.10.0 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/traffic-influence-user-story-use-case-1.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [Device](/code/Test_definitions/traffic-influence-postTrafficInfluenceDevice.feature), [Every User](/code/Test_definitions/traffic-influence-postTrafficInfluence.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | Y | r1.2 | +| 10 | API release numbering convention applied | M | M | M | M | Y | r1.3 | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public-release was certified | O | O | O | M | N | | | 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/d4JlBQ) | @@ -29,3 +29,4 @@ To fill the checklist: Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine). + From 1e4b514984611731a80afcc88696a0cd66b4f008 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 9 Sep 2025 16:02:08 +0200 Subject: [PATCH 15/20] Update CHANGELOG.md --- CHANGELOG.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 36bf226..a6610ae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -47,9 +47,9 @@ The traffic can be influenced even when the user device moves to a different geo ### Changed * x-correlator update: https://github.com/camaraproject/TrafficInfluence/pull/49 -* Alignment with the CAMARA Error codes: https://github.com/camaraproject/TrafficInfluence/pull/53 +* Alignment with the CAMARA Error codes: https://github.com/camaraproject/TrafficInfluence/pull/53 and https://github.com/camaraproject/TrafficInfluence/pull/73 * Updated the name of the test file to be coherent with the operationId: https://github.com/camaraproject/TrafficInfluence/pull/53 -* ErrorInfo scheme updated: https://github.com/camaraproject/TrafficInfluence/pull/65 +* ErrorInfo scheme updated: https://github.com/camaraproject/TrafficInfluence/pull/65 and https://github.com/camaraproject/TrafficInfluence/pull/73 ### Fixed * Backslash \ is not standard markdown syntax for paragraph: https://github.com/camaraproject/TrafficInfluence/pull/53 @@ -137,4 +137,4 @@ The traffic can be influenced even when the user device moves to a different geo * @nicolacdnll * @Kevsy -**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 \ No newline at end of file +**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 From 251ae84ddd6a57dfa0e4541e3eae4a81362a5e96 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 9 Sep 2025 16:04:11 +0200 Subject: [PATCH 16/20] typo --- .../traffic-influence-API-Readiness-Checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md b/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md index 79b0c03..967cc25 100644 --- a/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md +++ b/documentation/API_documentation/traffic-influence-API-Readiness-Checklist.md @@ -5,7 +5,7 @@ Checklist for traffic-influence v0.10.0 in r.1.3 | 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/traffic-influence.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r332](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) | +| 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.10.0 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | @@ -30,3 +30,4 @@ Note: the checklists of a public API version and of its preceding release-candid The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine). + From c3a58be73447a910c0685474ab94f7697ff1cd0d Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 15 Sep 2025 08:48:32 +0200 Subject: [PATCH 17/20] Delete unnecessary README --- documentation/API_documentation/README.MD | 1 - 1 file changed, 1 deletion(-) delete mode 100644 documentation/API_documentation/README.MD 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. From fbafd44c701b58be52564c521c69ecc2588f05aa Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 16 Sep 2025 14:03:32 +0200 Subject: [PATCH 18/20] r1.2 as pre-release --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a6610ae..7217559 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -65,7 +65,7 @@ The traffic can be influenced even when the user device moves to a different geo ## Release Notes -This release contains the definition and documentation of: +This pre-release contains the definition and documentation of: * traffic-influence v0.10.0-rc.1 The API definition(s) are based on From 23f0dc1ac4c62bd689c546a902702482494b4492 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 16 Sep 2025 16:05:27 +0200 Subject: [PATCH 19/20] last wip --- CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7217559..dbd4511 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -96,6 +96,8 @@ The traffic can be influenced even when the user device moves to a different geo ### Fixed * Backslash \ is not standard markdown syntax for paragraph: https://github.com/camaraproject/TrafficInfluence/pull/53 +* 409 error code in patch operation: https://github.com/camaraproject/TrafficInfluence/pull/77 + ### Removed **Full Changelog**: https://github.com/camaraproject/TrafficInfluence/compare/r1.1...r1.2 @@ -137,4 +139,4 @@ The traffic can be influenced even when the user device moves to a different geo * @nicolacdnll * @Kevsy -**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 +**Full Changelog**: https://github.com/camaraproject/TrafficInfluence/commits/r1.1 \ No newline at end of file From e2c01eee7386dcae17f343f6c8e77c7fe9e345a6 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 16 Sep 2025 16:11:23 +0200 Subject: [PATCH 20/20] fix --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dbd4511..e19d27e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -50,6 +50,7 @@ The traffic can be influenced even when the user device moves to a different geo * Alignment with the CAMARA Error codes: https://github.com/camaraproject/TrafficInfluence/pull/53 and https://github.com/camaraproject/TrafficInfluence/pull/73 * Updated the name of the test file to be coherent with the operationId: https://github.com/camaraproject/TrafficInfluence/pull/53 * ErrorInfo scheme updated: https://github.com/camaraproject/TrafficInfluence/pull/65 and https://github.com/camaraproject/TrafficInfluence/pull/73 +* 409 error code in patch operation: https://github.com/camaraproject/TrafficInfluence/pull/77 ### Fixed * Backslash \ is not standard markdown syntax for paragraph: https://github.com/camaraproject/TrafficInfluence/pull/53 @@ -96,7 +97,6 @@ The traffic can be influenced even when the user device moves to a different geo ### Fixed * Backslash \ is not standard markdown syntax for paragraph: https://github.com/camaraproject/TrafficInfluence/pull/53 -* 409 error code in patch operation: https://github.com/camaraproject/TrafficInfluence/pull/77 ### Removed