feat(irs-api):[#199] added changelog entry

catenax-ng · Mar 11, 2024 · c65f58e · c65f58e
2 parents 1898634 + 3e6eb1c
commit c65f58e
Show file tree

Hide file tree

Showing 48 changed files with 4,507 additions and 3,984 deletions.
diff --git a/.config/README.md b/.config/README.md
@@ -0,0 +1,19 @@
+
+[[Back to main IRS README](../README.md)]
+
+# .config Folder
+
+This folder contains configuration, rules and suppression files for code quality check tools etc.
+
+| File / Folder               | Description                                                                               | Further information                                                                                                    |
+|-----------------------------|-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
+| spectral                    |                                                                                           |                                                                                                                        | 
+| .trivyignore                | Ignore file for [Trivy](https://trivy.dev/) to configure which false positives to ignore. | [Trivy ignorefile documentation](https://aquasecurity.github.io/trivy/v0.49/docs/configuration/filtering/#trivyignore) |
+| checkstyle.xml              | [Checkstyle](https://checkstyle.sourceforge.io) configuration.                            | [Checkstyle configuration](https://checkstyle.sourceforge.io/config.html)                                              |
+| checkstyle-suppressions.xml | [Checkstyle](https://checkstyle.sourceforge.io/) suppressions.                            | [Checkstyle suppressions documentation](https://checkstyle.sourceforge.io/filters/suppressionfilter.html)              |
+| irs.header                  | Copyright header definition for the checkstyle module RegexpHeader.                       | see checkstyle.xml file                                                                                                |
+| owasp-suppressions.xml      | [OWASP dependendy check](https://owasp.org/www-project-dependency-check/) suppressions.   | [OWASP suppressions documentation](https://jeremylong.github.io/DependencyCheck/general/suppression.html)              |
+| pmd-rules.xml               | [PMD Source Code Analyzer](https://pmd.github.io/) rules.                                 | [PMD rules documentation](https://pmd.github.io/pmd/pmd_userdocs_making_rulesets.html)                                 |
+| spotbugs-excludes.xml       | [Spotbugs](https://spotbugs.github.io/) excludes.                                         | [Spotbugs excludes documentation](https://spotbugs.readthedocs.io/en/stable/filter.html)                               |
+
+
diff --git a/.github/workflows/helm-chart-release.yaml b/.github/workflows/helm-chart-release.yaml
@@ -57,7 +57,7 @@ jobs:
       - name: Install Helm
         uses: azure/setup-helm@v3
         with:
-          version: v3.8.1
+          version: v3.9.3
 
       - name: Update helm dependencies for irs
         working-directory: charts/irs-helm/

diff --git a/AUTHORS.md b/AUTHORS.md
@@ -16,6 +16,7 @@ The following people have contributed to this repository:
 - Sebastian Bezold, Mercedes Benz AG, https://github.com/SebastianBezold
 - Zied Belkhiria, MHP, https://github.com/Zied-Belkhiria-Mhp
 - Adam Bugajewski, doubleSlash Net-Business GmbH, https://github.com/ds-ext-abugajewski
+- Pawel Sosnowski, doubleSlash Net-Business GmbH, https://github.com/ds-psosnowski
 - Matthias Fischer, doubleSlash Net-Business GmbH, https://github.com/dsmf
 - Sebastian Ceronik, doubleSlash Net-Business GmbH, https://github.com/ds-ext-sceronik
 - Maximilian Wesener, doubleSlash Net-Business GmbH, https://github.com/ds-mwesener
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,24 +4,36 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+_**For better traceability add the corresponding GitHub issue number in each changelog entry, please.**_
+
 ## [Unreleased]
+### Changed
+
+- EdcPolicyDefinitionService, EdcContractDefinitionService and EdcAssetService return existing resource if it exists in
+  EDC
+- Added AssetAdministrationShellDescriptor specificAssetIds support for externalSubjectId required for data provisioning
+- Policies can now be registered for certain bpnls. #199
+
+
+## [4.7.0] - 2024-03-04
 ### Added
 - DigitalTwinRegistryCreateShellService in irs-registry-client for creating shells in DTR directly
 - POST /management/v2/contractagreements/request and GET /management/v2/contractagreements/{contractAgreementId}/negotiation to irs-edc-client lib
 
 ### Changed
 - EDC client handles multiple Digital Twin Registries and Digital Twins now #395
 - Change logo of irs
-- Added 'businessPartnerNumber' field to Tombstone model. This will be filled only when UsagePolicyValidation tombstone is being created.
+- Added 'businessPartnerNumber' field to Tombstone model. This will be filled only when UsagePolicyValidation tombstone is being created. #404
 
 ### Fixed
-- Update to Spring Boot 3.1.9 to fix CVE's.
-- Fixed a case where Policy validation could result in a NullPointerException if either orConstraint or andConstraint of
-  accepted policies were null
+- Update to Spring Boot 3.1.9 to fix CVE's. #423
+- Fixed a case where policy validation could result in a NullPointerException
+  if either orConstraint or andConstraint of accepted policies were null. #436
 
 ## [4.6.0] - 2024-02-20
 ### Added
-- Added concept to conform with IndustryCore Changes CX-0126 and CX-127
+
+- Added concept to conform with IndustryCore Changes CX-0126 and CX-127. #367
 - Added release instructions to CONTRIBUTING.md
 - EdcAssetService capable to create assets inside EDC
 - EdcPolicyDefinitionService capable to create polices inside EDC
@@ -32,7 +44,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Reduced log level in MeterRegistryService in order to avoid excessive logging
 
 ### Fixed
-- Fixed Log4J configuration
+
+- Fixed Log4J configuration. #396
 - Fix tavern and cucumber tests
 
 ## [4.5.2] - 2024-02-22
@@ -41,23 +54,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [4.5.1] - 2024-02-20
 ### Changed
-- Moved Docker notice to separate file #425
+
+- Moved Docker notice to separate file. #425
 
 ## [4.5.0] - 2024-02-07
 ### Added
 - Added helper script for building documentation locally.
 - Added new job parameter flag "auditContractNegotiation" which toggles setting contractAgreementId in Shells and Submodels
 - Added "contractAgreementId" field to Submodel model
-- Added Integration Tests for the entire IRS flow using stubbed responses of Discovery Service, Semantic Hub, EDC, Digital Twin Registry and BPDM Pool
+- Added Integration Tests for the entire IRS flow using stubbed responses of Discovery Service, Semantic Hub, EDC,
+  Digital Twin Registry and BPDM Pool. #344
 
 ### Changed
-- Dataspace Discovery Service handles multiple EDC-Urls received for BPN now
-- Updated license header to "Copyright (c) 2021,2024 Contributors to the Eclipse Foundation"
+
+- Dataspace Discovery Service handles multiple EDC-Urls received for BPN now. #214
+- Updated license header to "Copyright (c) 2021,2024 Contributors to the Eclipse Foundation" #349
 - Changed lookupGlobalAssetIds to lookupShellsByBPN, which provides full object.
 - Suppressed CVE-2024-20932 from graal-sdk-21.2.0.jar because this is not applicable for IRS.
 - Updated configuration of `DISCOVERY_REST_TEMPLATE` from `ess.discovery.*` to `digitalTwinRegistry.discovery.*` and discovery finder URL from `digitalTwinRegistry.discoveryFinderUrl` to `digitalTwinRegistry.discovery.discoveryFinderUrl`
-- Redesigned Shell object - wrapped payload and added "contractAgreementId" field
-- Changed structure of Policy creation to match EDC format
+- Redesigned shell object - wrapped payload and added "contractAgreementId" field. #370
+- Changed structure of policy creation to match EDC format. #249
 - Update irs-registry-client to 1.6.0-SNAPSHOT
 
 ### Fixed
@@ -68,22 +84,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [4.4.0] - 2024-01-15
 ### Added
-- Added EDR token cache to reuse token after contract negotiation
-- Added cache mechanism in DiscoveryFinderClientImpl for findDiscoveryEndpoints
-- Add concept docs/#322-Provisioning-of-contractAgreementId-for-assets.md
+
+- Added EDR token cache to reuse token after contract negotiation. #256
+- Added cache mechanism in DiscoveryFinderClientImpl for findDiscoveryEndpoints. #225
+- Add concept docs/#322-Provisioning-of-contractAgreementId-for-assets.md. #322
 
 ### Changed
-- Authentication was redesigned to use API keys, instead of OAuth2 protocol. The api key has to be sent as a X-API-KEY request header. IRS is supporting two types of API keys - one for admin and one for regular/view usage. Use new ``apiKeyAdmin`` and ``apiKeyRegular`` config entries to set up API keys.
+
+- Authentication was redesigned to use API keys, instead of OAuth2 protocol. The api key has to be sent as an X-API-KEY
+  request header. IRS is supporting two types of API keys - one for admin and one for regular/view usage. Use
+  new ``apiKeyAdmin`` and ``apiKeyRegular`` config entries to set up API keys. #259
 
 ### Removed
-- Removed ``oauth.resourceClaim``, ``oauth.irsNamespace``,``oauth.roles``,``oauth2.jwkSetUri`` config entries
+
+- Removed ``oauth.resourceClaim``, ``oauth.irsNamespace``,``oauth.roles``,``oauth2.jwkSetUri`` config entries. #259
 
 ## [4.3.0] - 2023-12-08
 ### Added
-- Added support for `hasAlternatives` property in SingleLevelBomAsBuilt aspect
+
+- Added support for `hasAlternatives` property in SingleLevelBomAsBuilt aspect. #296
 
 ### Changed
-- Updated edc dependencies to 0.2.1
+
+- Updated EDC dependencies to 0.2.1
 - Update deprecated field `providerUrl` to `counterPartyAddress` in EDC catalog request
 - Update ESS EDC notification creation asset endpoint to v3
 
@@ -95,14 +118,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Added `impactedSuppliersOnFirstTier` parameter to Supply SupplyChainImpacted Aspect model - contains information of first level supply chain impacted
 - Exported health endpoints to prometheus (see HealthMetricsExportConfiguration,
   DependenciesHealthMetricsExportConfiguration) and
-  added [system health dashboard](charts/irs-helm/dashboards/system-health-dashboard.json) in order to visualize health
-  metrics of IRS and its dependencies
+  added [system health dashboard](charts/irs-helm/dashboards/system-health-dashboard.json)
+  in order to visualize health metrics of IRS and its dependencies. #283
 
 ### Fixed
 - Fixed incorrect passing of incidentBPNS for ESS Orders
 
 ### Known knowns
-- [#253] Cancelation of order jobs is not working stable
+
+- [#253] Cancellation of order jobs is not working stable
 
 ## [4.1.0] - 2023-11-15
 ### Added
@@ -549,7 +573,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Unresolved
 - **Select Aspects you need**  You are able to select the needed aspects for which you want to collect the correct endpoint information.
 
-[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.6.0...HEAD
+[Unreleased]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.7.0...HEAD
+[4.7.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.6.0...4.7.0
 [4.6.0]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.5.2...4.6.0
 [4.5.2]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.5.1...4.5.2
 [4.5.1]: https://github.com/eclipse-tractusx/item-relationship-service/compare/4.5.0...4.5.1

diff --git a/COMPATIBILITY_MATRIX.md b/COMPATIBILITY_MATRIX.md
@@ -3,6 +3,21 @@
 Full changelog of IRS: [changelog](CHANGELOG.md)
 
 
+## [4.7.0] - 2024-03-04
+| Dependency                | Version                      | Helm       | Comments        |
+|---------------------------|------------------------------|------------|-----------------|
+| EDC                       | 0.5.3                        | 0.5.3      |                 |
+| EDC PostgresSQL           | 15.1.0-debian-11-r12         | 12.1.6     | Optional        |
+| MIW                       | 0.1.0                        | 0.1.0      | REST connection |
+| Semantics Hub             | 0.1.29                       | v0.2.11-M1 | REST connection |
+| DTR                       | 0.3.14-M1                    | 0.3.22     | REST connection |
+| Minio                     | RELEASE.2022-11-11T03-44-20Z | 5.0.1      |                 |
+| SingleLevelBomAsBuilt     | 2.0.0                        | -          | Model version   | 
+| SingleLevelBomAsPlanned   | 2.0.0                        | -          | Model version   | 
+| SingleLevelBomAsSpecified | 1.0.0                        | -          | Model version   | 
+| SingleLevelUsageAsBuilt   | 2.0.0                        | -          | Model version   | 
+
+
 ## [4.6.0] - 2024-02-20
 | Dependency                | Version                      | Helm       | Comments        |
 |---------------------------|------------------------------|------------|-----------------|

diff --git a/CONTACT.md b/CONTACT.md
@@ -0,0 +1,7 @@
+
+# Getting in Touch
+
+Contact the [project developers](AUTHORS.md) via the project's "dev" list.
+
+* [Mailing List](https://accounts.eclipse.org/mailing-list/tractusx-dev)
+* [Eclipse Matrix Chat](https://chat.eclipse.org/#/room/#tractusx-irs:matrix.eclipse.org)