Skip to content

Latest commit

 

History

History
273 lines (180 loc) · 11.3 KB

CHANGELOG.md

File metadata and controls

273 lines (180 loc) · 11.3 KB
Raw

Changelog

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/),

For changes to the BPDM Helm charts please consult the changelog of the charts directly.

[6.0.1] - [2024-05-27]

Removed

  • BPDM Gate: Remove unused business partner type filter in query parameters from sharing state endpoint (Does not affect behaviour of API)
  • Apps: Add no-auth profile to all BPDM applications. This introduced a shortcut to run an application without any authentication configuration for its API and clients

Changed

  • BPDM Gate: Now correctly sending NULL values for alternative addresses to the golden record process
  • BPDM Pool: Name search for business partners now case-insensitive and delivers results on partial matches
  • BPDM Pool: Now validate and reject data in golden record tasks only if it is needed for processing (Unchanged business partners are now ignored)

[6.0.0] - [2024-05-15]

Removed

  • BPDM Bridge (The Cleaning Dummy Service and Orchestrator are the successor applications to simulate a dummy golden record process)
  • BPDM Gate: Removed all Legal Entity, Site and Address endpoints (The generic business partner endpoint is their successor)
  • BPDM Gate: Removed legal entity classifications form business partner
  • BPDM Gate: Removed business partner type from API models and filters
  • BPDM Gate: Removed BPN from the sharing state (BPNs can be viewed in the output data of the business partner)
  • APIs: Removed the static prefixes 'api/catena' from all API endpoint paths
  • BPDM Pool: Removed the flags for is legal address and is site main address from the logistic address (since it is now expressed by the address type)

Added

  • BPDM Gate: Configuration to prevent the uploaded business partner input data to immediately enter the golden record process. In this configuration the business partner data needs to be sent to the golden record process manually over the new state/ready API endpoint. Default configuration remains automatically sharing.
  • BPDM Gate: Limited multi-tenancy support. Business partners are now separated by owner-BPNL. The owner is determined from the 'bpn' claim in the token. This means users of a Gate can only see and edit their own business partner data.
  • BPDM Pool: New API endpoints to query business partner data which belongs to Catena-X members only
  • APIs: Added a major version number to all API endpoint paths indicating the current version of the BPDM APIs. In the future we will use version numbers in the URL to differentiate between all currently supported major versions of the API
  • BPDM Gate Client: Now supports the stats endpoints of the BPDM API

Changed

  • Confidence Criteria: Corrected field name for number of sharing members (formerly number of business partners)
  • BPDM Cleaning Service Dummy: Now determines business partner data to be Catena-X member data if it is claimed to be owned
  • BPDM Cleaning Service Dummy: Fix ignoring BPNs coming from the sharing member
  • BPDM Gate: Fix not correctly updating confidence values it receives from the golden record process
  • BPDM Gate: Fix not correctly updating business partner output data from golden record updates in the Pool.
  • JAVA version to 21
  • BPDM API Permissions: Overhaul of the permissions needed to access the BPDM API endpoints. Permissions are now more fine-granular and differentiate more clearly between read or write. For more details consult the Arc42, API documentation and properties files of the respective applications.
  • BPDM App Configuration: Now all applications are secured (authenticated and authorized) by default. You can still deactivate security in the BPDM apps for testing or development purposes though.
  • BPDM Pool: Fix Pool trying to update golden records which the golden record process indicated to have no changes
  • BPDM Orchestrator: The business partner data for golden record process tasks has been completely overhauled. Now business partner data is clearly divided into uncategorized, legal entity, site and additonal address data. This model is less verbose and contains less duplicate data. Additionally, both Pool and Gate can write and read from it making it unnecessary for a cleaning service to provide the data in two different models.

[5.0.0] - [2024-02-10]

Added

  • Golden Record Process Use Case: Update sharing member business partner from update in golden record
  • BPDM Gate: Stats endpoints
  • BPDM Gate: Additional possible roles to business partner
  • BPDM Cleaning Service Dummy: Duplicate check based on business partner name
  • Confidence criteria for all data models

Changed

  • Increase Spring Boot version to 3.1.8
  • Changed generic business partner model to include LSA typed properties
  • Addresses can now be legal and site main addresses at the same time
  • BPDM Gate: Refuse request if token is not issued for owner BPNL

Deleted

  • BPDM Pool: Opensearch component

[4.1.0] - 2023-11-03

Added

  • Golden record sharing process with dummy cleaning (see points below for details)
  • BPDM Orchestrator: New BPDM application managing golden record tasks
  • BPDM Cleaning Service Dummy: New BPDM application creating dummy cleaning results from golden record tasks
  • BPDM Gate: Endpoints for sharing generic business partner input
  • BPDM Gate: Endpoints for querying generic business partner output
  • BPDM Gate: Service logic for creating golden record tasks from business partner input and writing result in output
  • BPDM Pool: Service Logic for creating golden records from tasks
  • BPDM Pool: Service logic for assigning BPNs to golden record tasks
  • BPDM Pool: Search for name on address and legal entity level
  • Swagger: Bearer token authorization flow
  • Workflows: latest-alpha tag for Docker images
  • Docker: Healthcheck for images

Changed

  • Apps: Increase Spring Boot version to 3.1.5
  • BPDM Gate: New business partner type 'GENERIC' for changelog
  • BPDM Gate: New business partner type 'GENERIC' for sharing state
  • Workflows: Trivy now targets the latest alpha Docker image instead of the latest release version
  • Apps: Increase projectreactor.netty version to fix Trivy vulnerability

[4.0.1] - 2023-08-28

Changed

  • BPDM Pool API: Adjust API text descriptions to BPDM Standard
  • BPDM Gate API: Adjust API text descriptions to BPDM Standard

Added

  • BPDM Apps: Add legal files to packaged Jar files: LICENSE, NOTICE and DEPENDENCIES
  • BPDM Bridge Dummy: Add missing tests for updating business partners

Fixed

  • BPDM Pool: Fix duplicate identifier validation on creating new legal entities

[4.0.0] - 2023-08-15

Note

This version introduces breaking changes. Migration files will DELETE existing data in order to perform migration. Please create a back-up of your business partner data before updating.

Changed

  • BPDM Pool API: Adapt new data model for easier and more intuitive usage, independent of SaaS data model.
  • BPDM Gate API: Adapt new data model for easier and more intuitive usage, independent of SaaS data model.
  • BPDM: Update dependencies to mitigate vulnerabilities in old versions.

Added

  • BPDM bridge dummy: As new application module.
  • BPDM: Umbrella Chart with BPDM Bridge Dummy.

Fixed

  • BPDM: Deprecated endpoints for retrieving business partners in legacy format.
  • Endpoint for retrieving changelog entries has now improved filtering (breaking API change)

[3.2.2] - 2023-05-12

Changed

  • Move license "header" of ingress under metadata

  • Increase chart versions and adapt changelogs on each chart folder

  • Increase version release to 3.2.2

[3.2.1] - 2023-04-20

Changed

  • Changed increase to spring boot starter version 3.0.5
  • Override spring expression transitive dependency to versiomn to 6.0.8
  • Increase version release to 3.2.1

[3.2.0] - 2023-03-17

Added

  • BPDM Pool API: client library for accessing BPDM Pool API application
  • BPDM Gate API: client library for accessing a BPDM Gate API application

Fixed

  • BPDM Gate: internal server error when invoking the POST business-partners/type-match endpoint
  • BPDM Gate: output endpoints could miss returning any information for Business Partners in some cases
  • BPDM: security issue CVE-2022-1471
  • BPDM: applications returning 403 status code on internal errors

[3.1.0] - 2023-03-08

Changed

  • BPDM Gate: Endpoints returning input versions of legal entity, site and address now provide processStartedAt timestamp.
  • BPDM Gate: Endpoints for output versions of legal entity, site and address now return error infos and pending entries

Fixed

  • BPDM Gate: For a business partner with a child relation, this relation could be returned as parent relation erroneously.
  • BPDM Gate: When a business partner with a child relation was updated, this relation was erroneously deleted, rendering the previous child invalid.

[3.0.3] - 2023-02-23

Security

  • BPDM Pool: Update dependencies to mitigate vulnerabilities in old versions

Changed

  • Replaced manual JSON deserializer implementations for various DTOs by generic DataClassUnwrappedJsonDeserializer.

[3.0.2] - 2023-02-15

Changed

  • BPDM Pool: SaaS Sharing Service Importer now also adds missing import entries (SaaS-ID to BPN) when encountering Business Partners that already have BPNs in the SaaS storage (possible due to legacy imports done before)
  • BPDM Pool: Business Partner searches have now limited pagination length. Limit is adjustable in configuration.

Fixed

  • BPDM Gate: Now possible to startup without supplying any environment variables or property overwrites
  • BPDM Pool: Now possible to deep paginate over business partners (>10000 entries)
  • Fixed various vulnerabilities by upgrading affected libraries

[3.0.1] - 2023-01-24

Security

  • Fixed various vulnerabilities by upgrading affected libraries

[3.0.0] - 2022-11-30

Added

  • New endpoint to search for addresses in pool
  • New endpoint to get valid/mandatory identifiers per country

Changed

  • Importer in pool now supports Legal Entities, Sites and Addresses
  • Update helm charts to align with best practices
  • Update logic for fetching data from SaaS provider via gate

[2.0.2] - 2022-11-17

Added

  • New component "gate" for the integration into the Golden Record process
  • Endpoint for creating and retrieving legal entities via gate
  • Endpoint for type matching via gate

[2.0.1] - 2022-10-20

Fixed

  • Fixed issue in legal entity import for missing "thoroughfare" values
  • Fix issue when elliptic curve signing key is configured in keycloak

Security

  • Update dependencies with CVEs

[2.0.0] - 2022-09-21

Added

  • Added the possibility to get BusinessPartner-Legal Entities, BusinessPartner-Sites and BusinessPartner-Addresses as additional information
  • Added OpenSearch functionality to search Business Partners by different parameters
  • Added reference integration for one SaaS controller
  • Helm Charts available via Helm repository
  • Swagger UI now integrated with Portal authentication
  • BPDM data model

Deprecated

  • Endpoints for retrieving business partners in legacy format