Release 1.3 (M4 Fall25)

CHANGELOG.md

@@ -3,6 +3,7 @@
 
 ## Table of Contents
 
+- **[r1.3](#r13)**
 - **[r1.2](#r12)**
 - **[r1.1](#r11)**
 
@@ -15,6 +16,47 @@ The below sections record the changes for each API version in each release as fo
 * for subsequent release-candidate(s), only the delta to the previous release-candidate
 * for a public release, the consolidated changes since the previous public release
 
+# r1.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 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-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 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
+
+### 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
+* Rollback 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/commits/r1.3
+
 # r1.2
 
 ## Release Notes
@@ -38,6 +80,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
@@ -46,7 +89,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 +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

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)
+* `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.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)
 

code/API_definitions/energy-footprint-notification.yaml

@@ -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-notification/vwip"
+  - url: "{apiRoot}/energy-footprint-notification/v0.1"
     variables:
       apiRoot:
         default: http://localhost:9091

code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature

@@ -1,16 +1,16 @@
-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:
 #
 # 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"

code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature

@@ -1,16 +1,16 @@
-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:
 #
 # 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"

documentation/API_documentation/energy-footprint-notification-API-Readiness-Checklist.md → documentation/API_documentation/energy-footprint-API-Readiness-Checklist.md

@@ -2,22 +2,27 @@
 
 # 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<br>public | stable<br> 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) |
+
+
+
+
+