From c6046ab2cd4668ded91249f1512cce01b767034a Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 19 Aug 2025 16:03:48 +0200 Subject: [PATCH 01/43] M4 OAS public release --- code/API_definitions/energy-footprint-notification.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/code/API_definitions/energy-footprint-notification.yaml b/code/API_definitions/energy-footprint-notification.yaml index 7d5f7ba..cfec709 100644 --- a/code/API_definitions/energy-footprint-notification.yaml +++ b/code/API_definitions/energy-footprint-notification.yaml @@ -21,7 +21,7 @@ info: **Example use case and flow:** - [**Edge Service energy report**](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.2/documentation/API_documentation/EFN_UserStory_UseCase_1.md) + [**Edge Service energy report**](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/documentation/API_documentation/EFN_UserStory_UseCase_1.md) ## API Documentation ## Details @@ -125,7 +125,7 @@ info: As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - version: wip + version: 0.1.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -137,7 +137,7 @@ externalDocs: # Servers # ############################################################################ servers: - - url: "{apiRoot}/energy-footprint/vwip" + - url: "{apiRoot}/energy-footprint/v0.1" variables: apiRoot: default: http://localhost:9091 From 0e9f22b8296195a3a541ab6e748b19e9fec6625e Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 19 Aug 2025 16:16:09 +0200 Subject: [PATCH 02/43] M4 Test --- ...footprint-notification-calculateCarbonFootprint.feature | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature b/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature index 5b451e2..c7e72ef 100644 --- a/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature +++ b/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Energy Footprint Notification API vwip - Operation calculateCarbonFootprint and carbonFootprintNotification +Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateCarbonFootprint and carbonFootprintNotification # Input to be provided by the implementation to the tester # # Implementation indications: @@ -6,11 +6,11 @@ Feature: CAMARA Energy Footprint Notification API vwip - Operation calculateCarb # Testing assets: # * One or more application instances whose carbon footprint can be evaluated. # -# References to OAS spec schemas refer to schemas specified in energy-footprint-notification.yaml, version wip +# References to OAS spec schemas refer to schemas specified in energy-footprint-notification.yaml, version 0.1.0 Background: Common calculate-carbon-footprint setup Given an environment at "apiRoot" - And the path "/energy-footprint-notification/vwip/calculate-carbon-footprint" + And the path "/energy-footprint-notification/v0.1/calculate-carbon-footprint" 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" @@ -59,3 +59,4 @@ Feature: CAMARA Energy Footprint Notification API vwip - Operation calculateCarb And "/components/schemas/CloudEventCarbonFootprint" in the callback should contain the parameter"$.carbonFootprint" And the parameter"$.carbonFootprint" should be se to the expected value as sum of the carbon footprint of all the application instances + From 3bf3871c6b3cf878e41d19c89a4db16ab310825f Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 19 Aug 2025 16:29:14 +0200 Subject: [PATCH 03/43] M4 Test --- ...otprint-notification-calculateEnergyConsumption.feature | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature b/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature index 4bc33a2..2399213 100644 --- a/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature +++ b/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Energy Footprint Notification API vwip - Operation calculateEnergyConsumption and energyConsumptionNotification +Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateEnergyConsumption and energyConsumptionNotification # Input to be provided by the implementation to the tester # # Implementation indications: @@ -6,11 +6,11 @@ Feature: CAMARA Energy Footprint Notification API vwip - Operation calculateEner # Testing assets: # * One or more application instances whose energy consumption can be evaluated. # -# References to OAS spec schemas refer to schemas specified in energy-footprint-notification.yaml, version wip +# References to OAS spec schemas refer to schemas specified in energy-footprint-notification.yaml, version 0.1.0 Background: Common energy-footprint-notification setup Given an environment at "apiRoot" - And the path "/energy-footprint-notification/vwip/calculate-energy-consumption" + And the path "/energy-footprint-notification/v0.1/calculate-energy-consumption" 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" @@ -58,3 +58,4 @@ Feature: CAMARA Energy Footprint Notification API vwip - Operation calculateEner And "/components/schemas/CloudEventEnergy" in the callback should contain the parameter "$.requestID" with the same value as in the 201 response of "/calculate-energy-consumption" And "/components/schemas/CloudEventEnergy" in the callback should contain the parameter"$.energyConsumption" And the parameter"$.energyConsumption" should be set to the expected value as sum of the energy concumption of all the application instances + From 93ae5c04f2fc71967dd0ad42fe657202ec074345 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 19 Aug 2025 16:30:14 +0200 Subject: [PATCH 04/43] M4 readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8589dd4..43413af 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,12 @@ Sandbox API Repository to describe, develop, document, and test the EnergyFootpr * 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/EnergyFootprintNotification/releases/tag/r1.2) with energy-footprint-notification v0.1.0-rc.1 is available. - * version v0.1.0-rc.1 of the **API energy-footprint-notification** - available [here](https://github.com/camaraproject/EnergyFootprintNotification/tree/r1.2) +* `The latest public release is [r1.3](https://github.com/camaraproject/EnergyFootprintNotification/releases/tag/r1.3) with energy-footprint-notification v0.1.0 is available. + * version v0.1.0 of the **API energy-footprint-notification** - available [here](https://github.com/camaraproject/EnergyFootprintNotification/tree/r1.3) * API definitions **with inline documentation**: - * OpenAPI [YAML](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.2/code/API_definitions/energy-footprint-notification.yaml) - * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/refs/tags/r1.2/code/API_definitions/energy-footprint-notification.yaml&nocors) - * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/refs/tags/r1.2/code/API_definitions/energy-footprint-notification.yaml) + * OpenAPI [YAML](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint-notification.yaml) + * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/refs/tags/r1.3/code/API_definitions/energy-footprint-notification.yaml&nocors) + * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/refs/tags/r1.3/code/API_definitions/energy-footprint-notification.yaml) For changes see [CHANGELOG.md](https://github.com/camaraproject/EnergyFootprintNotification/blob/main/CHANGELOG.md) From 788d87d36197952f5c43df20ae19823546d4fcb5 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 19 Aug 2025 16:31:02 +0200 Subject: [PATCH 05/43] M4 changelog --- CHANGELOG.md | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 21a21cc..dc490b2 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,43 @@ 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 release contains the definition and documentation of: +* energy-footprint-notification v0.1.0 + +The API definition(s) are based on +* Commonalities v0.6.0 +* Identity and Consent Management v0.4.0 + +## energy-footprint-notification v0.1.0 +This is the first release candidate of the CAMARA EnergyFootprintNotification API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint-notification.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml) + +### Added +* Support for the following use cases: https://github.com/camaraproject/EnergyFootprintNotification/discussions/11 + +### 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 +* info.description reordering: https://github.com/camaraproject/EnergyFootprintNotification/pull/92 +* ErrorInfo update according to Commonalities 6.0 public release: https://github.com/camaraproject/EnergyFootprintNotification/pull/95 + +### Fixed +* operationId calculatEnergyConsumption: https://github.com/camaraproject/EnergyFootprintNotification/issues/88 + +### Removed + + +**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/compare/r1.1...r1.3 + # r1.2 ## Release Notes @@ -46,7 +84,7 @@ This is the first release candidate of the CAMARA EnergyFootprintNotification AP ### Removed -**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1...r1.2 +**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/compare/r1.1...r1.2 # r1.1 @@ -80,4 +118,4 @@ This is the first pre-release of the CAMARA EnergyFootprintNotification API supp ## New Contributors * @FabrizioMoggio -**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 +**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 \ No newline at end of file From bd68b04cf00974a943568616e6d859dcfda8eac9 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 19 Aug 2025 16:45:43 +0200 Subject: [PATCH 06/43] MegaLint Fix --- ...ergy-footprint-notification-calculateCarbonFootprint.feature | 2 -- 1 file changed, 2 deletions(-) diff --git a/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature b/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature index c7e72ef..d31b46b 100644 --- a/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature +++ b/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature @@ -57,6 +57,4 @@ Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateCa And the callback carries the information defined in "/components/schemas/CloudEventCarbonFootprint" And "/components/schemas/CloudEventCarbonFootprint" in the callback should contain the parameter "$.requestID" with the same value as in the 201 response of "/calculate-carbon-footprint" And "/components/schemas/CloudEventCarbonFootprint" in the callback should contain the parameter"$.carbonFootprint" - And the parameter"$.carbonFootprint" should be se to the expected value as sum of the carbon footprint of all the application instances - From f19a10ed870d79c92025529609fcfa6a04a57839 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 19 Aug 2025 16:46:05 +0200 Subject: [PATCH 07/43] MegaLint Fix --- ...rgy-footprint-notification-calculateEnergyConsumption.feature | 1 - 1 file changed, 1 deletion(-) diff --git a/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature b/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature index 2399213..1489065 100644 --- a/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature +++ b/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature @@ -58,4 +58,3 @@ Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateEn And "/components/schemas/CloudEventEnergy" in the callback should contain the parameter "$.requestID" with the same value as in the 201 response of "/calculate-energy-consumption" And "/components/schemas/CloudEventEnergy" in the callback should contain the parameter"$.energyConsumption" And the parameter"$.energyConsumption" should be set to the expected value as sum of the energy concumption of all the application instances - From 37836bae0254f2c452363b7eb4b9e93131e4a6ab Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 20 Aug 2025 11:26:17 +0200 Subject: [PATCH 08/43] M4 RCL --- ...-footprint-notification-API-Readiness-Checklist.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/documentation/API_documentation/energy-footprint-notification-API-Readiness-Checklist.md b/documentation/API_documentation/energy-footprint-notification-API-Readiness-Checklist.md index 54a3454..5302da7 100644 --- a/documentation/API_documentation/energy-footprint-notification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/energy-footprint-notification-API-Readiness-Checklist.md @@ -2,22 +2,23 @@ # API Readiness Checklist -Checklist for API energy-footprint-notification 0.1.0-rc.1 in r1.2 +Checklist for API energy-footprint-notification 0.1.0 in r1.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/energy_footprint_notification.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 | 0.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 | 0.1.0 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/EFN_UserStory_UseCase_1.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [Test-EC](/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature), [Test-CF](/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.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 | | | 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/spaces/CAM/pages/81101707/EnergyFootprintNotification+API+description) | + From 2ff0edd22fcf874ea26a4947cf5649f9a66ec8fb Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 25 Aug 2025 14:18:17 +0200 Subject: [PATCH 09/43] Update CHANGELOG.md --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dc490b2..1474eed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,7 +28,7 @@ The API definition(s) are based on * Identity and Consent Management v0.4.0 ## energy-footprint-notification v0.1.0 -This is the first release candidate of the CAMARA EnergyFootprintNotification API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. +This is the first public release of the CAMARA Energy Footprint Notification API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint-notification.yaml) @@ -118,4 +118,4 @@ This is the first pre-release of the CAMARA EnergyFootprintNotification API supp ## New Contributors * @FabrizioMoggio -**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 \ No newline at end of file +**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 From 653d194326599eda4a58e4d864c4ea8e4eed6687 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 25 Aug 2025 14:31:09 +0200 Subject: [PATCH 10/43] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 43413af..a937a6f 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ Sandbox API Repository to describe, develop, document, and test the EnergyFootpr * 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 is [r1.3](https://github.com/camaraproject/EnergyFootprintNotification/releases/tag/r1.3) with energy-footprint-notification v0.1.0 is available. +* `NEW`: The latest public release is [r1.3](https://github.com/camaraproject/EnergyFootprintNotification/releases/tag/r1.3) with energy-footprint-notification v0.1.0 is available. * version v0.1.0 of the **API energy-footprint-notification** - available [here](https://github.com/camaraproject/EnergyFootprintNotification/tree/r1.3) * API definitions **with inline documentation**: * OpenAPI [YAML](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint-notification.yaml) From 18c108cfd178d85167672149c65f67dad02a782e Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:02:00 +0200 Subject: [PATCH 11/43] Rename energy-footprint-notification.yaml to energy-footprint.yaml https://github.com/camaraproject/EnergyFootprintNotification/pull/98#issuecomment-3239415698 --- .../{energy-footprint-notification.yaml => energy-footprint.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename code/API_definitions/{energy-footprint-notification.yaml => energy-footprint.yaml} (100%) diff --git a/code/API_definitions/energy-footprint-notification.yaml b/code/API_definitions/energy-footprint.yaml similarity index 100% rename from code/API_definitions/energy-footprint-notification.yaml rename to code/API_definitions/energy-footprint.yaml From e0669400553bbfb0a07b462371c2e79d7edc1906 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:02:41 +0200 Subject: [PATCH 12/43] Rename energy-footprint-notification-calculateCarbonFootprint.feature to energy-footprint-calculateCarbonFootprint.feature https://github.com/camaraproject/EnergyFootprintNotification/pull/98#issuecomment-3239415698 --- ....feature => energy-footprint-calculateCarbonFootprint.feature} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename code/Test_definitions/{energy-footprint-notification-calculateCarbonFootprint.feature => energy-footprint-calculateCarbonFootprint.feature} (100%) diff --git a/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature b/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature similarity index 100% rename from code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature rename to code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature From 70be9ec492cbfd032570760794ab00a9351c89fb Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:03:14 +0200 Subject: [PATCH 13/43] Rename energy-footprint-notification-calculateEnergyConsumption.feature to energy-footprint-calculateEnergyConsumption.feature https://github.com/camaraproject/EnergyFootprintNotification/pull/98#issuecomment-3239415698 --- ...eature => energy-footprint-calculateEnergyConsumption.feature} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename code/Test_definitions/{energy-footprint-notification-calculateEnergyConsumption.feature => energy-footprint-calculateEnergyConsumption.feature} (100%) diff --git a/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature b/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature similarity index 100% rename from code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature rename to code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature From b11ad5f74218ad10d396c09b9c7ca920025376ad Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:04:03 +0200 Subject: [PATCH 14/43] Update energy-footprint-calculateEnergyConsumption.feature renamed from "EFN" to "EF" --- .../energy-footprint-calculateEnergyConsumption.feature | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature b/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature index 1489065..65aed06 100644 --- a/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature +++ b/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateEnergyConsumption and energyConsumptionNotification +Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateEnergyConsumption and energyConsumptionNotification # Input to be provided by the implementation to the tester # # Implementation indications: @@ -6,7 +6,7 @@ Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateEn # Testing assets: # * One or more application instances whose energy consumption can be evaluated. # -# References to OAS spec schemas refer to schemas specified in energy-footprint-notification.yaml, version 0.1.0 +# References to OAS spec schemas refer to schemas specified in energy-footprint.yaml, version 0.1.0 Background: Common energy-footprint-notification setup Given an environment at "apiRoot" @@ -58,3 +58,4 @@ Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateEn And "/components/schemas/CloudEventEnergy" in the callback should contain the parameter "$.requestID" with the same value as in the 201 response of "/calculate-energy-consumption" And "/components/schemas/CloudEventEnergy" in the callback should contain the parameter"$.energyConsumption" And the parameter"$.energyConsumption" should be set to the expected value as sum of the energy concumption of all the application instances + From 84d01756c887d914fcb32348ecb7217b993ea51b Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:04:45 +0200 Subject: [PATCH 15/43] Update energy-footprint-calculateCarbonFootprint.feature renamed from "EFN" to "EF" --- .../energy-footprint-calculateCarbonFootprint.feature | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature b/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature index d31b46b..0b2b05c 100644 --- a/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature +++ b/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateCarbonFootprint and carbonFootprintNotification +Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateCarbonFootprint and carbonFootprintNotification # Input to be provided by the implementation to the tester # # Implementation indications: @@ -6,7 +6,7 @@ Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateCa # Testing assets: # * One or more application instances whose carbon footprint can be evaluated. # -# References to OAS spec schemas refer to schemas specified in energy-footprint-notification.yaml, version 0.1.0 +# References to OAS spec schemas refer to schemas specified in energy-footprint.yaml, version 0.1.0 Background: Common calculate-carbon-footprint setup Given an environment at "apiRoot" @@ -58,3 +58,4 @@ Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateCa And "/components/schemas/CloudEventCarbonFootprint" in the callback should contain the parameter "$.requestID" with the same value as in the 201 response of "/calculate-carbon-footprint" And "/components/schemas/CloudEventCarbonFootprint" in the callback should contain the parameter"$.carbonFootprint" And the parameter"$.carbonFootprint" should be se to the expected value as sum of the carbon footprint of all the application instances + From a831a233871e14163080a04a1f51e9cc94b3ca22 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:05:51 +0200 Subject: [PATCH 16/43] Update and rename energy-footprint-notification-API-Readiness-Checklist.md to energy-footprint-API-Readiness-Checklist.md renamed from "EFN" to "EF" --- ...hecklist.md => energy-footprint-API-Readiness-Checklist.md} | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) rename documentation/API_documentation/{energy-footprint-notification-API-Readiness-Checklist.md => energy-footprint-API-Readiness-Checklist.md} (91%) diff --git a/documentation/API_documentation/energy-footprint-notification-API-Readiness-Checklist.md b/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md similarity index 91% rename from documentation/API_documentation/energy-footprint-notification-API-Readiness-Checklist.md rename to documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md index 5302da7..f878631 100644 --- a/documentation/API_documentation/energy-footprint-notification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md @@ -14,7 +14,7 @@ Checklist for API energy-footprint-notification 0.1.0 in r1.3 | 4 | API versioning convention applied | M | M | M | M | Y | 0.1.0 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/EFN_UserStory_UseCase_1.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [Test-EC](/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature), [Test-CF](/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [Test-EC](/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature), [Test-CF](/code/Test_definitions/energy-footprint-calculateCarbonFootprint.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 | @@ -22,3 +22,4 @@ Checklist for API energy-footprint-notification 0.1.0 in r1.3 | 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/spaces/CAM/pages/81101707/EnergyFootprintNotification+API+description) | + From 03f099150dcb7f1c597c117835bf69b74ef55e1c Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:06:37 +0200 Subject: [PATCH 17/43] EFN to EF --- .../energy-footprint-API-Readiness-Checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md b/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md index f878631..85d51ef 100644 --- a/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md +++ b/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md @@ -2,7 +2,7 @@ # API Readiness Checklist -Checklist for API energy-footprint-notification 0.1.0 in r1.3 +Checklist for API energy-footprint 0.1.0 in r1.3 @@ -23,3 +23,4 @@ Checklist for API energy-footprint-notification 0.1.0 in r1.3 | 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101707/EnergyFootprintNotification+API+description) | + From 91395a7b4f1c6db923f62f3b152eb7ce55796d13 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:08:55 +0200 Subject: [PATCH 18/43] EFN to EF https://github.com/camaraproject/EnergyFootprintNotification/pull/98#issuecomment-3239415698 --- CHANGELOG.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1474eed..57117de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ -# Changelog CAMARA EnergyFootprintNotification +# Changelog CAMARA EnergyFootprint ## Table of Contents @@ -21,19 +21,19 @@ The below sections record the changes for each API version in each release as fo ## Release Notes This release contains the definition and documentation of: -* energy-footprint-notification v0.1.0 +* energy-footprint v0.1.0 The API definition(s) are based on * Commonalities v0.6.0 * Identity and Consent Management v0.4.0 -## energy-footprint-notification v0.1.0 -This is the first public release of the CAMARA Energy Footprint Notification API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. +## energy-footprint v0.1.0 +This is the first release candidate of the CAMARA EnergyFootprint API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint-notification.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint.yaml) ### Added * Support for the following use cases: https://github.com/camaraproject/EnergyFootprintNotification/discussions/11 @@ -47,25 +47,25 @@ This is the first public release of the CAMARA Energy Footprint Notification API ### Fixed * operationId calculatEnergyConsumption: https://github.com/camaraproject/EnergyFootprintNotification/issues/88 +* completed the transition of the APi name from EnergyFootprintNotification to EnergyFootprint: https://github.com/camaraproject/EnergyFootprintNotification/pull/98 ### Removed - -**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/compare/r1.1...r1.3 +**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commit/r1.3 # r1.2 ## Release Notes This release contains the definition and documentation of: -* energy-footprint-notification v0.1.0-rc.1 +* energy-footprint v0.1.0-rc.1 The API definition(s) are based on * Commonalities v0.6.0-rc.1 * Identity and Consent Management v0.4.0-rc.1 -## energy-footprint-notification v0.1.0-rc.1 -This is the first release candidate of the CAMARA EnergyFootprintNotification API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. +## energy-footprint v0.1.0-rc.1 +This is the first release candidate of the CAMARA EnergyFootprint API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.2/code/API_definitions/energy-footprint-notification.yaml) @@ -76,6 +76,7 @@ This is the first release candidate of the CAMARA EnergyFootprintNotification AP ### Changed +* Rename of the API from EnergyFootprintNotification to EnergyFootprint: https://github.com/camaraproject/EnergyFootprintNotification/pull/83 * 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 @@ -118,4 +119,4 @@ This is the first pre-release of the CAMARA EnergyFootprintNotification API supp ## New Contributors * @FabrizioMoggio -**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 +**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 \ No newline at end of file From a0bf0f806c52c8f501799d740a3a4de547272812 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:15:14 +0200 Subject: [PATCH 19/43] EF-Notification in CloudEvent https://github.com/camaraproject/EnergyFootprintNotification/pull/98#issuecomment-3239415698 --- code/API_definitions/energy-footprint.yaml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/code/API_definitions/energy-footprint.yaml b/code/API_definitions/energy-footprint.yaml index cfec709..c2be13b 100644 --- a/code/API_definitions/energy-footprint.yaml +++ b/code/API_definitions/energy-footprint.yaml @@ -307,7 +307,7 @@ components: example: id: "string" source: "https://notificationSendServer12.supertelco.com" - type: "org.camaraproject.energy-footprint-notification.v1.energy" + type: "org.camaraproject.energy-footprint.v1.energy" specversion: "1.0" datacontenttype: "application/json" data: @@ -359,7 +359,7 @@ components: example: id: "string" source: "https://notificationSendServer12.supertelco.com" - type: "org.camaraproject.energy-footprint-notification.v1.carbon-footprint" + type: "org.camaraproject.energy-footprint.v1.carbon-footprint" specversion: "1.0" datacontenttype: "application/json" data: @@ -576,15 +576,15 @@ components: type: string description: Event triggered when an event-type event occurred. enum: - - org.camaraproject.energy-footprint-notification.v1.energy - - org.camaraproject.energy-footprint-notification.v1.carbon-footprint + - org.camaraproject.energy-footprint.v1.energy + - org.camaraproject.energy-footprint.v1.carbon-footprint SubscriptionEventType: type: string description: | event-type that could be subscribed through this subscription. Several event-type could be defined. enum: - - org.camaraproject.energy-footprint-notification.v1.energy - - org.camaraproject.energy-footprint-notification.v1.carbon-footprint + - org.camaraproject.energy-footprint.v1.energy + - org.camaraproject.energy-footprint.v1.carbon-footprint ReportCreationRequest: description: resource containing the service under analysis and the callback information for the API Consumer to be notified with the @@ -694,8 +694,8 @@ components: discriminator: propertyName: "type" mapping: - org.camaraproject.energy-footprint-notification.v1.energy: "#/components/schemas/CloudEventEnergy" - org.camaraproject.energy-footprint-notification.v1.carbon-footprint: "#/components/schemas/CloudEventCarbonFootprint" + org.camaraproject.energy-footprint.v1.energy: "#/components/schemas/CloudEventEnergy" + org.camaraproject.energy-footprint.v1.carbon-footprint: "#/components/schemas/CloudEventCarbonFootprint" CloudEventEnergy: description: provides back the energy consumption for the service. The result of the analysis is a floating point number. The unit of measure From e69f848eef0cd271c439c3abe8c846f6ed1090ff Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:18:16 +0200 Subject: [PATCH 20/43] Server URL removed "-notification" --- .../energy-footprint-calculateCarbonFootprint.feature | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature b/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature index 0b2b05c..72069bc 100644 --- a/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature +++ b/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature @@ -10,7 +10,7 @@ Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateCarbonFootprint Background: Common calculate-carbon-footprint setup Given an environment at "apiRoot" - And the path "/energy-footprint-notification/v0.1/calculate-carbon-footprint" + And the path "/energy-footprint/v0.1/calculate-carbon-footprint" 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" @@ -59,3 +59,4 @@ Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateCarbonFootprint And "/components/schemas/CloudEventCarbonFootprint" in the callback should contain the parameter"$.carbonFootprint" And the parameter"$.carbonFootprint" should be se to the expected value as sum of the carbon footprint of all the application instances + From eca0ba31a998e30da9c9dc92f2c5050c2291a578 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:18:46 +0200 Subject: [PATCH 21/43] Server URL removed "-notification" --- .../energy-footprint-calculateEnergyConsumption.feature | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature b/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature index 65aed06..c68ed21 100644 --- a/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature +++ b/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature @@ -10,7 +10,7 @@ Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateEnergyConsumpti Background: Common energy-footprint-notification setup Given an environment at "apiRoot" - And the path "/energy-footprint-notification/v0.1/calculate-energy-consumption" + And the path "/energy-footprint/v0.1/calculate-energy-consumption" 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" @@ -59,3 +59,4 @@ Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateEnergyConsumpti And "/components/schemas/CloudEventEnergy" in the callback should contain the parameter"$.energyConsumption" And the parameter"$.energyConsumption" should be set to the expected value as sum of the energy concumption of all the application instances + From a67e6006d3dfffb5f309b7fd591d67b9d2d4f4ca Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:24:14 +0200 Subject: [PATCH 22/43] Rename energy-footprint.yaml to energy-footprint-notification.yaml --- .../{energy-footprint.yaml => energy-footprint-notification.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename code/API_definitions/{energy-footprint.yaml => energy-footprint-notification.yaml} (100%) diff --git a/code/API_definitions/energy-footprint.yaml b/code/API_definitions/energy-footprint-notification.yaml similarity index 100% rename from code/API_definitions/energy-footprint.yaml rename to code/API_definitions/energy-footprint-notification.yaml From 096f49c50dba5105a27d1c3a0d95b9768b7a131d Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:31:46 +0200 Subject: [PATCH 23/43] Revert to Energy Footprint Notification --- .../energy-footprint-notification.yaml | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/code/API_definitions/energy-footprint-notification.yaml b/code/API_definitions/energy-footprint-notification.yaml index c2be13b..c9bb9f5 100644 --- a/code/API_definitions/energy-footprint-notification.yaml +++ b/code/API_definitions/energy-footprint-notification.yaml @@ -4,10 +4,10 @@ openapi: 3.0.3 # API info # ############################################################################ info: - title: Energy Footprint + title: Energy Footprint Notification description: | ## Overview - The Energy Footprint API provides the API Consumer + The Energy Footprint Notification API provides the API Consumer with information about the energy consumption and carbon footprint of a service exposed by a set of applications instances. ## Introduction @@ -25,7 +25,7 @@ info: ## API Documentation ## Details - The Energy Footprint API provides, to the API Consumer, + The Energy Footprint Notification API provides, to the API Consumer, information about the energy consumption and carbon footprint for a specified service that is provided by a certain number of active instances of some applications. The API provides information about the aggregated @@ -40,7 +40,7 @@ info: is also aware of the energy consumption in the Data Centers hosting the applications instances providing the service. The Operator's Network is deeply involved in the service provisioning, so its energy consumption is - relevant to have and view. The Energy Footprint API also considers the energy + relevant to have and view. The Energy Footprint Notification API also considers the energy consumption and the carbon footprint for the network traffic generated by the Operator's subscribers consuming the service. The Service Provider activates a service using the Operator Platform to instantiate and activate @@ -49,16 +49,16 @@ info: instances to enable the service. Service customers use their devices to access the service. The use of the service produces an energy consumption alongside the Operator's Network and on the Data Centers hosting - the applications instances. The Energy Footprint API is used by a Service Provider to be + the applications instances. The Energy Footprint Notification API is used by a Service Provider to be aware of the energy consumption of the service. The Service Provider, - via an Energy Footprint API Consumer, invokes the Energy Footprint API with the identifiers of the + via an Energy Footprint Notification API Consumer, invokes the Energy Footprint Notification API with the identifiers of the application instances supporting the target service. A period of - time can be specified. The Energy Footprint API provides back the energy consumption by - the service in that period of time. The Energy Footprint API also provides back the + time can be specified. The Energy Footprint Notification API provides back the energy consumption by + the service in that period of time. The Energy Footprint Notification API also provides back the carbon footprint related to the running of the service. - The Energy Footprint API is an intent based API. + The Energy Footprint Notification API is an intent based API. - The Energy Footprint API supports the following Intents: + The Energy Footprint Notification API supports the following Intents: - Intent1: Which is the overall energy consumption for my service in this period of time? - Intent2: Which is the overall carbon footprint for my service in this @@ -76,7 +76,7 @@ info: - Intent1: /overall-energy-consumption - Intent2: /overall-carbon-footprint - **The main elements of the Energy Footprint API are:** + **The main elements of the Energy Footprint Notification API are:** **ReportCreationRequest:** Information about the target service (as a @@ -137,7 +137,7 @@ externalDocs: # Servers # ############################################################################ servers: - - url: "{apiRoot}/energy-footprint/v0.1" + - url: "{apiRoot}/energy-footprint-notification/v0.1" variables: apiRoot: default: http://localhost:9091 @@ -307,7 +307,7 @@ components: example: id: "string" source: "https://notificationSendServer12.supertelco.com" - type: "org.camaraproject.energy-footprint.v1.energy" + type: "org.camaraproject.energy-footprint-notification.v1.energy" specversion: "1.0" datacontenttype: "application/json" data: @@ -359,7 +359,7 @@ components: example: id: "string" source: "https://notificationSendServer12.supertelco.com" - type: "org.camaraproject.energy-footprint.v1.carbon-footprint" + type: "org.camaraproject.energy-footprint-notification.v1.carbon-footprint" specversion: "1.0" datacontenttype: "application/json" data: @@ -576,15 +576,15 @@ components: type: string description: Event triggered when an event-type event occurred. enum: - - org.camaraproject.energy-footprint.v1.energy - - org.camaraproject.energy-footprint.v1.carbon-footprint + - org.camaraproject.energy-footprint-notification.v1.energy + - org.camaraproject.energy-footprint-notification.v1.carbon-footprint SubscriptionEventType: type: string description: | event-type that could be subscribed through this subscription. Several event-type could be defined. enum: - - org.camaraproject.energy-footprint.v1.energy - - org.camaraproject.energy-footprint.v1.carbon-footprint + - org.camaraproject.energy-footprint-notification.v1.energy + - org.camaraproject.energy-footprint-notification.v1.carbon-footprint ReportCreationRequest: description: resource containing the service under analysis and the callback information for the API Consumer to be notified with the @@ -694,8 +694,8 @@ components: discriminator: propertyName: "type" mapping: - org.camaraproject.energy-footprint.v1.energy: "#/components/schemas/CloudEventEnergy" - org.camaraproject.energy-footprint.v1.carbon-footprint: "#/components/schemas/CloudEventCarbonFootprint" + org.camaraproject.energy-footprint-notification.v1.energy: "#/components/schemas/CloudEventEnergy" + org.camaraproject.energy-footprint-notification.v1.carbon-footprint: "#/components/schemas/CloudEventCarbonFootprint" CloudEventEnergy: description: provides back the energy consumption for the service. The result of the analysis is a floating point number. The unit of measure From a4de44fd020d385fe458246731f9a147a59470c7 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:33:45 +0200 Subject: [PATCH 24/43] revert to energy footprint notification --- ...ootprint-notification-calculateCarbonFootprint.feature} | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) rename code/Test_definitions/{energy-footprint-calculateCarbonFootprint.feature => energy-footprint-notification-calculateCarbonFootprint.feature} (92%) diff --git a/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature b/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature similarity index 92% rename from code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature rename to code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature index 72069bc..aae2df5 100644 --- a/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature +++ b/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateCarbonFootprint and carbonFootprintNotification +Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateCarbonFootprint and carbonFootprintNotification # Input to be provided by the implementation to the tester # # Implementation indications: @@ -6,11 +6,11 @@ Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateCarbonFootprint # Testing assets: # * One or more application instances whose carbon footprint can be evaluated. # -# References to OAS spec schemas refer to schemas specified in energy-footprint.yaml, version 0.1.0 +# References to OAS spec schemas refer to schemas specified in energy-footprint-notification.yaml, version 0.1.0 Background: Common calculate-carbon-footprint setup Given an environment at "apiRoot" - And the path "/energy-footprint/v0.1/calculate-carbon-footprint" + And the path "/energy-footprint-notification/v0.1/calculate-carbon-footprint" 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" @@ -60,3 +60,4 @@ Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateCarbonFootprint And the parameter"$.carbonFootprint" should be se to the expected value as sum of the carbon footprint of all the application instances + From 1a1950548f59872ccdca3867e0388f6d333ab8d5 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:34:35 +0200 Subject: [PATCH 25/43] revert to energy footprint notification --- ...tprint-notification-calculateEnergyConsumption.feature} | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) rename code/Test_definitions/{energy-footprint-calculateEnergyConsumption.feature => energy-footprint-notification-calculateEnergyConsumption.feature} (92%) diff --git a/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature b/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature similarity index 92% rename from code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature rename to code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature index c68ed21..ba15cce 100644 --- a/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature +++ b/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateEnergyConsumption and energyConsumptionNotification +Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateEnergyConsumption and energyConsumptionNotification # Input to be provided by the implementation to the tester # # Implementation indications: @@ -6,11 +6,11 @@ Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateEnergyConsumpti # Testing assets: # * One or more application instances whose energy consumption can be evaluated. # -# References to OAS spec schemas refer to schemas specified in energy-footprint.yaml, version 0.1.0 +# References to OAS spec schemas refer to schemas specified in energy-footprint-notification.yaml, version 0.1.0 Background: Common energy-footprint-notification setup Given an environment at "apiRoot" - And the path "/energy-footprint/v0.1/calculate-energy-consumption" + And the path "/energy-footprint-notification/v0.1/calculate-energy-consumption" 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" @@ -60,3 +60,4 @@ Feature: CAMARA Energy Footprint API v0.1.0 - Operation calculateEnergyConsumpti And the parameter"$.energyConsumption" should be set to the expected value as sum of the energy concumption of all the application instances + From 4d27eee264922e2cc1a6563e32dae91f092e4c84 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:36:09 +0200 Subject: [PATCH 26/43] rallback to Energy Footprint Notification --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 57117de..e6e19c7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -44,10 +44,10 @@ This is the first release candidate of the CAMARA EnergyFootprint API supporting * Updated the name of the test file to be coherent with the operationId: https://github.com/camaraproject/EnergyFootprintNotification/pull/83 * info.description reordering: https://github.com/camaraproject/EnergyFootprintNotification/pull/92 * ErrorInfo update according to Commonalities 6.0 public release: https://github.com/camaraproject/EnergyFootprintNotification/pull/95 +* rallback of the API name to EnergyFootprintNotification from EnergyFootprint: https://github.com/camaraproject/EnergyFootprintNotification/pull/98 ### Fixed * operationId calculatEnergyConsumption: https://github.com/camaraproject/EnergyFootprintNotification/issues/88 -* completed the transition of the APi name from EnergyFootprintNotification to EnergyFootprint: https://github.com/camaraproject/EnergyFootprintNotification/pull/98 ### Removed @@ -119,4 +119,4 @@ This is the first pre-release of the CAMARA EnergyFootprintNotification API supp ## New Contributors * @FabrizioMoggio -**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 \ No newline at end of file +**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 From 360e5f4004f66d362481e5e3b456761f2debbb93 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:41:15 +0200 Subject: [PATCH 27/43] openId back to EFNotification --- code/API_definitions/energy-footprint-notification.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/energy-footprint-notification.yaml b/code/API_definitions/energy-footprint-notification.yaml index c9bb9f5..cf1ff2a 100644 --- a/code/API_definitions/energy-footprint-notification.yaml +++ b/code/API_definitions/energy-footprint-notification.yaml @@ -170,7 +170,7 @@ paths: - $ref: '#/components/parameters/x-correlator' security: - openId: - - 'energy-footprint:calculate-energy-consumption' + - 'energy-footprint-notification:calculate-energy-consumption' requestBody: description: Defines the application that provides the service and the time period under analysis. @@ -219,7 +219,7 @@ paths: - $ref: '#/components/parameters/x-correlator' security: - openId: - - 'energy-footprint:calculate-carbon-footprint' + - 'energy-footprint-notification:calculate-carbon-footprint' requestBody: description: Defines the application that provides the service and the time period under analysis. From 2aa4a1183b4b2ad6d36de1085e2dc0c5a7a5a80a Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:51:25 +0200 Subject: [PATCH 28/43] ML Fix --- ...rgy-footprint-notification-calculateCarbonFootprint.feature | 3 --- 1 file changed, 3 deletions(-) diff --git a/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature b/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature index aae2df5..d31b46b 100644 --- a/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature +++ b/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature @@ -58,6 +58,3 @@ Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateCa And "/components/schemas/CloudEventCarbonFootprint" in the callback should contain the parameter "$.requestID" with the same value as in the 201 response of "/calculate-carbon-footprint" And "/components/schemas/CloudEventCarbonFootprint" in the callback should contain the parameter"$.carbonFootprint" And the parameter"$.carbonFootprint" should be se to the expected value as sum of the carbon footprint of all the application instances - - - From def3d768680eb85014ad8a69c1697b9563309e31 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:51:56 +0200 Subject: [PATCH 29/43] ML Fix --- ...y-footprint-notification-calculateEnergyConsumption.feature | 3 --- 1 file changed, 3 deletions(-) diff --git a/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature b/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature index ba15cce..1489065 100644 --- a/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature +++ b/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature @@ -58,6 +58,3 @@ Feature: CAMARA Energy Footprint Notification API v0.1.0 - Operation calculateEn And "/components/schemas/CloudEventEnergy" in the callback should contain the parameter "$.requestID" with the same value as in the 201 response of "/calculate-energy-consumption" And "/components/schemas/CloudEventEnergy" in the callback should contain the parameter"$.energyConsumption" And the parameter"$.energyConsumption" should be set to the expected value as sum of the energy concumption of all the application instances - - - From d47fa08a2abc430ec8ba9e47ec386ffef1395bc2 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 09:54:29 +0200 Subject: [PATCH 30/43] update endpoints in info.description --- code/API_definitions/energy-footprint-notification.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/energy-footprint-notification.yaml b/code/API_definitions/energy-footprint-notification.yaml index cf1ff2a..0c48b65 100644 --- a/code/API_definitions/energy-footprint-notification.yaml +++ b/code/API_definitions/energy-footprint-notification.yaml @@ -73,8 +73,8 @@ info: - Output_Intent2: greenhouse gases emission in tonnes. The related endpoints are: - - Intent1: /overall-energy-consumption - - Intent2: /overall-carbon-footprint + - Intent1: /calculate-energy-consumption + - Intent2: /calculate-carbon-footprint **The main elements of the Energy Footprint Notification API are:** From 963fe53a90e1e6cf2d4c81a5e6509e6113d86962 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 10:06:39 +0200 Subject: [PATCH 31/43] cloudevents+json --- code/API_definitions/energy-footprint-notification.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/code/API_definitions/energy-footprint-notification.yaml b/code/API_definitions/energy-footprint-notification.yaml index 0c48b65..b658fe4 100644 --- a/code/API_definitions/energy-footprint-notification.yaml +++ b/code/API_definitions/energy-footprint-notification.yaml @@ -300,7 +300,7 @@ components: description: payload containing the calculated energy consumption required: true content: - application/json: + application/cloudevents+json: schema: allOf: - $ref: '#/components/schemas/CloudEvent' @@ -309,7 +309,7 @@ components: source: "https://notificationSendServer12.supertelco.com" type: "org.camaraproject.energy-footprint-notification.v1.energy" specversion: "1.0" - datacontenttype: "application/json" + datacontenttype: "application/cloudevents+json" data: requestId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" energyConsumption: 12.87 @@ -353,7 +353,7 @@ components: requestBody: description: payload containing the calculated energy consumption content: - application/json: + application/cloudevents+json: schema: $ref: '#/components/schemas/CloudEvent' example: @@ -361,7 +361,7 @@ components: source: "https://notificationSendServer12.supertelco.com" type: "org.camaraproject.energy-footprint-notification.v1.carbon-footprint" specversion: "1.0" - datacontenttype: "application/json" + datacontenttype: "application/cloudevents+json" data: requestId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" carbonFootprint: 45.568 From b2625199d323c6976462fa840863b7296060dc17 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 10:33:37 +0200 Subject: [PATCH 32/43] ML Fix rallback Json --- code/API_definitions/energy-footprint-notification.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/code/API_definitions/energy-footprint-notification.yaml b/code/API_definitions/energy-footprint-notification.yaml index b658fe4..0c48b65 100644 --- a/code/API_definitions/energy-footprint-notification.yaml +++ b/code/API_definitions/energy-footprint-notification.yaml @@ -300,7 +300,7 @@ components: description: payload containing the calculated energy consumption required: true content: - application/cloudevents+json: + application/json: schema: allOf: - $ref: '#/components/schemas/CloudEvent' @@ -309,7 +309,7 @@ components: source: "https://notificationSendServer12.supertelco.com" type: "org.camaraproject.energy-footprint-notification.v1.energy" specversion: "1.0" - datacontenttype: "application/cloudevents+json" + datacontenttype: "application/json" data: requestId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" energyConsumption: 12.87 @@ -353,7 +353,7 @@ components: requestBody: description: payload containing the calculated energy consumption content: - application/cloudevents+json: + application/json: schema: $ref: '#/components/schemas/CloudEvent' example: @@ -361,7 +361,7 @@ components: source: "https://notificationSendServer12.supertelco.com" type: "org.camaraproject.energy-footprint-notification.v1.carbon-footprint" specversion: "1.0" - datacontenttype: "application/cloudevents+json" + datacontenttype: "application/json" data: requestId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" carbonFootprint: 45.568 From d7392c21541f7b1b357561dde976abc96b817608 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 11:48:57 +0200 Subject: [PATCH 33/43] rallback EF-Notification --- .../energy-footprint-API-Readiness-Checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md b/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md index 85d51ef..c02ea39 100644 --- a/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md +++ b/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md @@ -14,7 +14,7 @@ Checklist for API energy-footprint 0.1.0 in r1.3 | 4 | API versioning convention applied | M | M | M | M | Y | 0.1.0 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/EFN_UserStory_UseCase_1.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [Test-EC](/code/Test_definitions/energy-footprint-calculateEnergyConsumption.feature), [Test-CF](/code/Test_definitions/energy-footprint-calculateCarbonFootprint.feature) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [Test-EC](/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature), [Test-CF](/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.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 | @@ -24,3 +24,4 @@ Checklist for API energy-footprint 0.1.0 in r1.3 + From 30c3ad3dec5cf1a60a765c7aa09a9191e84e520d Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 11:54:01 +0200 Subject: [PATCH 34/43] Update energy-footprint-API-Readiness-Checklist.md --- .../energy-footprint-API-Readiness-Checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md b/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md index c02ea39..ced5257 100644 --- a/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md +++ b/documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md @@ -2,7 +2,7 @@ # API Readiness Checklist -Checklist for API energy-footprint 0.1.0 in r1.3 +Checklist for API energy-footprint-notification 0.1.0 in r1.3 @@ -25,3 +25,4 @@ Checklist for API energy-footprint 0.1.0 in r1.3 + From d39a00f9dc66aef3e80dafcc7a4d7c367357aedd Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 1 Sep 2025 16:44:16 +0200 Subject: [PATCH 35/43] with respect to v0.1.0-alpha.1 https://github.com/camaraproject/EnergyFootprintNotification/pull/98#discussion_r2312033992 --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e6e19c7..0e579e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,6 +35,8 @@ This is the first release candidate of the CAMARA EnergyFootprint API supporting - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint.yaml&nocors) - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint.yaml) +Considering this is the first public relase of the API, the modification reported below ("Changed" and "Fixed" sections) are with respect to v0.1.0-alpha.1. + ### Added * Support for the following use cases: https://github.com/camaraproject/EnergyFootprintNotification/discussions/11 From bdd717912eb2b1ba4d50a4ff398a1c8755c77d03 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 2 Sep 2025 14:51:35 +0200 Subject: [PATCH 36/43] EnergyFootprint to EnergyFootprintNotification --- CHANGELOG.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0e579e4..7e84c57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ -# Changelog CAMARA EnergyFootprint +# Changelog CAMARA EnergyFootprintNotification ## Table of Contents @@ -21,21 +21,21 @@ The below sections record the changes for each API version in each release as fo ## Release Notes This release contains the definition and documentation of: -* energy-footprint v0.1.0 +* energy-footprint-notification v0.1.0 The API definition(s) are based on * Commonalities v0.6.0 * Identity and Consent Management v0.4.0 -## energy-footprint v0.1.0 -This is the first release candidate of the CAMARA EnergyFootprint API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. +## energy-footprint-notification v0.1.0 +This is the first release candidate of the CAMARA EnergyFootprintNotification API supporting the retrieval of energy consumption information and carbon footprint for a service running over some application instances typically edge located. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint.yaml) - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint.yaml&nocors) - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint.yaml) -Considering this is the first public relase of the API, the modification reported below ("Changed" and "Fixed" sections) are with respect to v0.1.0-alpha.1. +This is the first public relase of the API, the modification reported below ("Changed" and "Fixed" sections) are with respect to v0.1.0-alpha.1. ### Added * Support for the following use cases: https://github.com/camaraproject/EnergyFootprintNotification/discussions/11 @@ -46,27 +46,29 @@ Considering this is the first public relase of the API, the modification reporte * Updated the name of the test file to be coherent with the operationId: https://github.com/camaraproject/EnergyFootprintNotification/pull/83 * info.description reordering: https://github.com/camaraproject/EnergyFootprintNotification/pull/92 * ErrorInfo update according to Commonalities 6.0 public release: https://github.com/camaraproject/EnergyFootprintNotification/pull/95 -* rallback of the API name to EnergyFootprintNotification from EnergyFootprint: https://github.com/camaraproject/EnergyFootprintNotification/pull/98 +* Rallback of the API name to EnergyFootprintNotification from EnergyFootprint: https://github.com/camaraproject/EnergyFootprintNotification/pull/103 + ### Fixed * operationId calculatEnergyConsumption: https://github.com/camaraproject/EnergyFootprintNotification/issues/88 +* CloudEvent data type format: https://github.com/camaraproject/EnergyFootprintNotification/pull/103 ### Removed -**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commit/r1.3 +**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.3 # r1.2 ## Release Notes This release contains the definition and documentation of: -* energy-footprint v0.1.0-rc.1 +* energy-footprint-notification v0.1.0-rc.1 The API definition(s) are based on * Commonalities v0.6.0-rc.1 * Identity and Consent Management v0.4.0-rc.1 -## energy-footprint v0.1.0-rc.1 +## energy-footprint-notification v0.1.0-rc.1 This is the first release candidate of the CAMARA EnergyFootprint API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. - API definition **with inline documentation**: @@ -121,4 +123,4 @@ This is the first pre-release of the CAMARA EnergyFootprintNotification API supp ## New Contributors * @FabrizioMoggio -**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 +**Full Changelog**: https://github.com/camaraproject/EnergyFootprintNotification/commits/r1.1 \ No newline at end of file From 217d90ffe60f79fb22c526d9824cbe4260d49da5 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 2 Sep 2025 14:53:39 +0200 Subject: [PATCH 37/43] still a missing "Notification" --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e84c57..608c174 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -69,7 +69,7 @@ The API definition(s) are based on * Identity and Consent Management v0.4.0-rc.1 ## energy-footprint-notification v0.1.0-rc.1 -This is the first release candidate of the CAMARA EnergyFootprint API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. +This is the first release candidate of the CAMARA EnergyFootprint Notification API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.2/code/API_definitions/energy-footprint-notification.yaml) From ced475e47b52fd10b41e2d3c08a9b774dfaf1989 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Tue, 2 Sep 2025 14:54:31 +0200 Subject: [PATCH 38/43] Typo --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 608c174..470d744 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -69,7 +69,7 @@ The API definition(s) are based on * Identity and Consent Management v0.4.0-rc.1 ## energy-footprint-notification v0.1.0-rc.1 -This is the first release candidate of the CAMARA EnergyFootprint Notification API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. +This is the first release candidate of the CAMARA EnergyFootprintNotification API supporting the retrieval of energy consumption information and carbon footprint for a Service running over some application instances typically edge located. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.2/code/API_definitions/energy-footprint-notification.yaml) From 5a96126b11205ddc685fa5e650b7b1a93e24c5c2 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 3 Sep 2025 14:52:40 +0200 Subject: [PATCH 39/43] 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 470d744..fbbb81b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,7 +28,7 @@ The API definition(s) are based on * Identity and Consent Management v0.4.0 ## energy-footprint-notification v0.1.0 -This is the first release candidate of the CAMARA EnergyFootprintNotification API supporting the retrieval of energy consumption information and carbon footprint for a service running over some application instances typically edge located. +This is the first public release of the CAMARA EnergyFootprintNotification API supporting the retrieval of energy consumption information and carbon footprint for a service running over some application instances typically edge located. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint.yaml) From 7fe9277819a7fc198e5df9d5189c7a3f89449151 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 3 Sep 2025 14:53:43 +0200 Subject: [PATCH 40/43] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fbbb81b..05b461a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,9 +31,9 @@ The API definition(s) are based on This is the first public release of the CAMARA EnergyFootprintNotification API supporting the retrieval of energy consumption information and carbon footprint for a service running over some application instances typically edge located. - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/EnergyFootprintNotification/blob/r1.3/code/API_definitions/energy-footprint-notification.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml) This is the first public relase of the API, the modification reported below ("Changed" and "Fixed" sections) are with respect to v0.1.0-alpha.1. From 8852b4315ad40d63335bcee489544c805e1b2dee Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 3 Sep 2025 14:54:16 +0200 Subject: [PATCH 41/43] 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 05b461a..0a54c1a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,7 +35,7 @@ This is the first public release of the CAMARA EnergyFootprintNotification API s - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml&nocors) - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml) -This is the first public relase of the API, the modification reported below ("Changed" and "Fixed" sections) are with respect to v0.1.0-alpha.1. +This is the first public relase of the API, the modification reported below ("Changed" and "Fixed" sections) are with respect to v0.1.0-rc.1 in r1.2. ### Added * Support for the following use cases: https://github.com/camaraproject/EnergyFootprintNotification/discussions/11 From 792cdbbf21bfbc492b22d2b9287bf180503e0e66 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 3 Sep 2025 14:54:26 +0200 Subject: [PATCH 42/43] 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 0a54c1a..5c407f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -46,7 +46,7 @@ This is the first public relase of the API, the modification reported below ("Ch * Updated the name of the test file to be coherent with the operationId: https://github.com/camaraproject/EnergyFootprintNotification/pull/83 * info.description reordering: https://github.com/camaraproject/EnergyFootprintNotification/pull/92 * ErrorInfo update according to Commonalities 6.0 public release: https://github.com/camaraproject/EnergyFootprintNotification/pull/95 -* Rallback of the API name to EnergyFootprintNotification from EnergyFootprint: https://github.com/camaraproject/EnergyFootprintNotification/pull/103 +* Rollback of the API name to EnergyFootprintNotification from EnergyFootprint: https://github.com/camaraproject/EnergyFootprintNotification/pull/103 ### Fixed From 3959797b230210b562049044a41b27451b74266e Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Thu, 4 Sep 2025 09:01:57 +0200 Subject: [PATCH 43/43] typo --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5c407f4..281832e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,7 +35,7 @@ This is the first public release of the CAMARA EnergyFootprintNotification API s - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml&nocors) - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/EnergyFootprintNotification/r1.3/code/API_definitions/energy-footprint-notification.yaml) -This is the first public relase of the API, the modification reported below ("Changed" and "Fixed" sections) are with respect to v0.1.0-rc.1 in r1.2. +This is the first public release of the API, the modification reported below ("Changed" and "Fixed" sections) are with respect to v0.1.0-rc.1 in r1.2. ### Added * Support for the following use cases: https://github.com/camaraproject/EnergyFootprintNotification/discussions/11