chore: Add decision record concerning downward compatibiity (#1797)

* chore: Add decision record concerning downward compatibiity

Signed-off-by: Lars Geyer-Blaumeiser <lars.blaumeiser@cofinity-x.com>

* rewrite dr based on review comments

Signed-off-by: Lars Geyer-Blaumeiser <lars.blaumeiser@cofinity-x.com>

* Add review comments

Signed-off-by: Lars Geyer-Blaumeiser <lars.blaumeiser@cofinity-x.com>

* dependencies

Signed-off-by: Lars Geyer-Blaumeiser <lars.blaumeiser@cofinity-x.com>

* review comments

Signed-off-by: Lars Geyer-Blaumeiser <lars.blaumeiser@cofinity-x.com>

* dependencies

Signed-off-by: Lars Geyer-Blaumeiser <lars.blaumeiser@cofinity-x.com>

---------

Signed-off-by: Lars Geyer-Blaumeiser <lars.blaumeiser@cofinity-x.com>

Author: lgblaumeiser

DEPENDENCIES

@@ -60,8 +60,11 @@ maven/mavencentral/com.fasterxml.jackson/jackson-bom/2.18.2, Apache-2.0, approve
 maven/mavencentral/com.fasterxml.uuid/java-uuid-generator/4.1.0, Apache-2.0, approved, clearlydefined
 maven/mavencentral/com.github.cliftonlabs/json-simple/3.0.2, Apache-2.0, approved, clearlydefined
 maven/mavencentral/com.github.docker-java/docker-java-api/3.4.0, Apache-2.0, approved, clearlydefined
+maven/mavencentral/com.github.docker-java/docker-java-api/3.4.1, Apache-2.0, approved, clearlydefined
 maven/mavencentral/com.github.docker-java/docker-java-transport-zerodep/3.4.0, Apache-2.0 AND (Apache-2.0 AND BSD-3-Clause), approved, #15745
+maven/mavencentral/com.github.docker-java/docker-java-transport-zerodep/3.4.1, Apache-2.0 AND (Apache-2.0 AND BSD-3-Clause), approved, #15745
 maven/mavencentral/com.github.docker-java/docker-java-transport/3.4.0, Apache-2.0, approved, clearlydefined
+maven/mavencentral/com.github.docker-java/docker-java-transport/3.4.1, Apache-2.0, approved, clearlydefined
 maven/mavencentral/com.github.java-json-tools/btf/1.3, Apache-2.0 OR LGPL-3.0-only, approved, #15201
 maven/mavencentral/com.github.java-json-tools/jackson-coreutils-equivalence/1.0, LGPL-3.0 OR Apache-2.0, approved, clearlydefined
 maven/mavencentral/com.github.java-json-tools/jackson-coreutils/2.0, Apache-2.0 OR LGPL-3.0-or-later, approved, #15186
@@ -207,11 +210,11 @@ maven/mavencentral/io.prometheus/simpleclient_httpserver/0.16.0, Apache-2.0, app
 maven/mavencentral/io.prometheus/simpleclient_tracer_common/0.16.0, Apache-2.0, approved, clearlydefined
 maven/mavencentral/io.prometheus/simpleclient_tracer_otel/0.16.0, Apache-2.0, approved, clearlydefined
 maven/mavencentral/io.prometheus/simpleclient_tracer_otel_agent/0.16.0, Apache-2.0, approved, clearlydefined
-maven/mavencentral/io.rest-assured/json-path/5.5.1, , restricted, clearlydefined
-maven/mavencentral/io.rest-assured/rest-assured-common/5.5.1, , restricted, clearlydefined
+maven/mavencentral/io.rest-assured/json-path/5.5.1, Apache-2.0, approved, #19524
+maven/mavencentral/io.rest-assured/rest-assured-common/5.5.1, Apache-2.0, approved, #19522
 maven/mavencentral/io.rest-assured/rest-assured/5.5.0, Apache-2.0, approved, #15676
 maven/mavencentral/io.rest-assured/rest-assured/5.5.1, Apache-2.0, approved, #15676
-maven/mavencentral/io.rest-assured/xml-path/5.5.1, , restricted, clearlydefined
+maven/mavencentral/io.rest-assured/xml-path/5.5.1, Apache-2.0, approved, #19523
 maven/mavencentral/io.setl/rdf-urdna/1.1, Apache-2.0, approved, clearlydefined
 maven/mavencentral/io.swagger.core.v3/swagger-annotations-jakarta/2.2.22, Apache-2.0, approved, #5947
 maven/mavencentral/io.swagger.core.v3/swagger-annotations-jakarta/2.2.25, Apache-2.0, approved, #5947
@@ -570,8 +573,8 @@ maven/mavencentral/org.eclipse.jetty/jetty-util/11.0.24, EPL-2.0 OR Apache-2.0,
 maven/mavencentral/org.eclipse.jetty/jetty-webapp/11.0.24, EPL-2.0 OR Apache-2.0, approved, rt.jetty
 maven/mavencentral/org.eclipse.jetty/jetty-xml/11.0.24, EPL-2.0 OR Apache-2.0, approved, rt.jetty
 maven/mavencentral/org.eclipse.parsson/parsson/1.1.7, EPL-2.0, approved, ee4j.parsson
-maven/mavencentral/org.flywaydb/flyway-core/11.3.2, Apache-2.0, approved, clearlydefined
-maven/mavencentral/org.flywaydb/flyway-database-postgresql/11.3.2, , restricted, clearlydefined
+maven/mavencentral/org.flywaydb/flyway-core/11.3.3, Apache-2.0, approved, clearlydefined
+maven/mavencentral/org.flywaydb/flyway-database-postgresql/11.3.3, NOASSERTION, restricted, clearlydefined
 maven/mavencentral/org.glassfish.hk2.external/aopalliance-repackaged/3.0.6, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish
 maven/mavencentral/org.glassfish.hk2/hk2-api/3.0.6, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish
 maven/mavencentral/org.glassfish.hk2/hk2-locator/3.0.6, EPL-2.0 OR GPL-2.0-only with Classpath-exception-2.0, approved, ee4j.glassfish
@@ -646,10 +649,15 @@ maven/mavencentral/org.slf4j/slf4j-api/2.0.16, MIT, approved, #5915
 maven/mavencentral/org.slf4j/slf4j-api/2.0.6, MIT, approved, #5915
 maven/mavencentral/org.slf4j/slf4j-api/2.0.9, MIT, approved, #5915
 maven/mavencentral/org.testcontainers/database-commons/1.20.4, Apache-2.0, approved, #16630
+maven/mavencentral/org.testcontainers/database-commons/1.20.5, Apache-2.0, approved, #16630
 maven/mavencentral/org.testcontainers/jdbc/1.20.4, Apache-2.0, approved, #16621
+maven/mavencentral/org.testcontainers/jdbc/1.20.5, Apache-2.0, approved, #16621
 maven/mavencentral/org.testcontainers/junit-jupiter/1.20.4, MIT, approved, #16552
+maven/mavencentral/org.testcontainers/junit-jupiter/1.20.5, MIT, approved, #16552
 maven/mavencentral/org.testcontainers/postgresql/1.20.4, MIT, approved, #16627
+maven/mavencentral/org.testcontainers/postgresql/1.20.5, MIT, approved, #16627
 maven/mavencentral/org.testcontainers/testcontainers/1.20.4, MIT, approved, #15747
+maven/mavencentral/org.testcontainers/testcontainers/1.20.5, MIT, approved, #15747
 maven/mavencentral/org.xmlresolver/xmlresolver/5.2.2, Apache-2.0, approved, clearlydefined
 maven/mavencentral/org.xmlunit/xmlunit-core/2.9.1, Apache-2.0, approved, #6272
 maven/mavencentral/org.xmlunit/xmlunit-placeholders/2.9.1, Apache-2.0, approved, clearlydefined
@@ -658,64 +666,64 @@ maven/mavencentral/org.yaml/snakeyaml/2.2, Apache-2.0 AND (Apache-2.0 OR BSD-3-C
 maven/mavencentral/org.yaml/snakeyaml/2.3, Apache-2.0 AND (Apache-2.0 OR BSD-3-Clause OR EPL-1.0 OR GPL-2.0-or-later OR LGPL-2.1-or-later), approved, #16046
 maven/mavencentral/org.yaml/snakeyaml/2.4, Apache-2.0, approved, #19469
 maven/mavencentral/software.amazon.awssdk/annotations/2.29.50, Apache-2.0, approved, #17015
-maven/mavencentral/software.amazon.awssdk/annotations/2.30.21, Apache-2.0, approved, #19166
+maven/mavencentral/software.amazon.awssdk/annotations/2.30.26, Apache-2.0, approved, #19166
 maven/mavencentral/software.amazon.awssdk/apache-client/2.29.50, Apache-2.0, approved, #17627
-maven/mavencentral/software.amazon.awssdk/apache-client/2.30.21, Apache-2.0, approved, clearlydefined
+maven/mavencentral/software.amazon.awssdk/apache-client/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/arns/2.29.50, Apache-2.0, approved, #16994
-maven/mavencentral/software.amazon.awssdk/arns/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/arns/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/auth/2.29.50, Apache-2.0, approved, #17626
-maven/mavencentral/software.amazon.awssdk/auth/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/auth/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/aws-core/2.29.50, Apache-2.0, approved, #17095
-maven/mavencentral/software.amazon.awssdk/aws-core/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/aws-core/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/aws-query-protocol/2.29.50, Apache-2.0, approved, #16999
-maven/mavencentral/software.amazon.awssdk/aws-query-protocol/2.30.21, Apache-2.0, approved, #19170
+maven/mavencentral/software.amazon.awssdk/aws-query-protocol/2.30.26, Apache-2.0, approved, #19170
 maven/mavencentral/software.amazon.awssdk/aws-xml-protocol/2.29.50, Apache-2.0, approved, #17004
-maven/mavencentral/software.amazon.awssdk/aws-xml-protocol/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/aws-xml-protocol/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/checksums-spi/2.29.50, Apache-2.0, approved, #17010
-maven/mavencentral/software.amazon.awssdk/checksums-spi/2.30.21, Apache-2.0, approved, clearlydefined
+maven/mavencentral/software.amazon.awssdk/checksums-spi/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/checksums/2.29.50, Apache-2.0, approved, #17003
-maven/mavencentral/software.amazon.awssdk/checksums/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/checksums/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/crt-core/2.29.50, Apache-2.0, approved, #17002
-maven/mavencentral/software.amazon.awssdk/crt-core/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/crt-core/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/endpoints-spi/2.29.50, Apache-2.0, approved, #16996
-maven/mavencentral/software.amazon.awssdk/endpoints-spi/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/endpoints-spi/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/http-auth-aws-eventstream/2.29.50, Apache-2.0, approved, #16995
-maven/mavencentral/software.amazon.awssdk/http-auth-aws-eventstream/2.30.21, Apache-2.0, approved, clearlydefined
+maven/mavencentral/software.amazon.awssdk/http-auth-aws-eventstream/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/http-auth-aws/2.29.50, Apache-2.0, approved, #17001
-maven/mavencentral/software.amazon.awssdk/http-auth-aws/2.30.21, Apache-2.0, approved, clearlydefined
+maven/mavencentral/software.amazon.awssdk/http-auth-aws/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/http-auth-spi/2.29.50, Apache-2.0, approved, #17005
-maven/mavencentral/software.amazon.awssdk/http-auth-spi/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/http-auth-spi/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/http-auth/2.29.50, Apache-2.0, approved, #16998
-maven/mavencentral/software.amazon.awssdk/http-auth/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/http-auth/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/http-client-spi/2.29.50, Apache-2.0, approved, #17014
-maven/mavencentral/software.amazon.awssdk/http-client-spi/2.30.21, Apache-2.0, approved, #19169
+maven/mavencentral/software.amazon.awssdk/http-client-spi/2.30.26, Apache-2.0, approved, #19169
 maven/mavencentral/software.amazon.awssdk/iam/2.29.50, Apache-2.0, approved, #16993
 maven/mavencentral/software.amazon.awssdk/identity-spi/2.29.50, Apache-2.0, approved, #17007
-maven/mavencentral/software.amazon.awssdk/identity-spi/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/identity-spi/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/json-utils/2.29.50, Apache-2.0, approved, #17013
-maven/mavencentral/software.amazon.awssdk/json-utils/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/json-utils/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/metrics-spi/2.29.50, Apache-2.0, approved, #17006
-maven/mavencentral/software.amazon.awssdk/metrics-spi/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/metrics-spi/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/netty-nio-client/2.29.50, Apache-2.0, approved, #17094
-maven/mavencentral/software.amazon.awssdk/netty-nio-client/2.30.21, Apache-2.0, approved, #19163
+maven/mavencentral/software.amazon.awssdk/netty-nio-client/2.30.26, Apache-2.0, approved, #19163
 maven/mavencentral/software.amazon.awssdk/profiles/2.29.50, Apache-2.0, approved, #17012
-maven/mavencentral/software.amazon.awssdk/profiles/2.30.21, Apache-2.0, approved, #19171
+maven/mavencentral/software.amazon.awssdk/profiles/2.30.26, Apache-2.0, approved, #19171
 maven/mavencentral/software.amazon.awssdk/protocol-core/2.29.50, Apache-2.0, approved, #17000
-maven/mavencentral/software.amazon.awssdk/protocol-core/2.30.21, Apache-2.0, approved, #19168
+maven/mavencentral/software.amazon.awssdk/protocol-core/2.30.26, Apache-2.0, approved, #19168
 maven/mavencentral/software.amazon.awssdk/regions/2.29.50, Apache-2.0, approved, #17631
-maven/mavencentral/software.amazon.awssdk/regions/2.30.21, Apache-2.0, approved, #19164
+maven/mavencentral/software.amazon.awssdk/regions/2.30.26, Apache-2.0, approved, #19164
 maven/mavencentral/software.amazon.awssdk/retries-spi/2.29.50, Apache-2.0, approved, #16997
-maven/mavencentral/software.amazon.awssdk/retries-spi/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/retries-spi/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/retries/2.29.50, Apache-2.0, approved, #17009
-maven/mavencentral/software.amazon.awssdk/retries/2.30.21, , restricted, clearlydefined
-maven/mavencentral/software.amazon.awssdk/s3-transfer-manager/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/retries/2.30.26, Apache-2.0, approved, clearlydefined
+maven/mavencentral/software.amazon.awssdk/s3-transfer-manager/2.30.26, , restricted, clearlydefined
 maven/mavencentral/software.amazon.awssdk/s3/2.29.50, Apache-2.0, approved, #17629
-maven/mavencentral/software.amazon.awssdk/s3/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/s3/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/sdk-core/2.29.50, Apache-2.0, approved, #17016
-maven/mavencentral/software.amazon.awssdk/sdk-core/2.30.21, Apache-2.0, approved, #19167
+maven/mavencentral/software.amazon.awssdk/sdk-core/2.30.26, Apache-2.0, approved, #19167
 maven/mavencentral/software.amazon.awssdk/sts/2.29.50, Apache-2.0, approved, #17630
 maven/mavencentral/software.amazon.awssdk/third-party-jackson-core/2.29.50, Apache-2.0, approved, #17008
-maven/mavencentral/software.amazon.awssdk/third-party-jackson-core/2.30.21, , restricted, clearlydefined
+maven/mavencentral/software.amazon.awssdk/third-party-jackson-core/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.awssdk/utils/2.29.50, Apache-2.0, approved, #17625
-maven/mavencentral/software.amazon.awssdk/utils/2.30.21, Apache-2.0, approved, clearlydefined
+maven/mavencentral/software.amazon.awssdk/utils/2.30.26, Apache-2.0, approved, clearlydefined
 maven/mavencentral/software.amazon.eventstream/eventstream/1.0.1, Apache-2.0, approved, clearlydefined

docs/development/decision-records/2025-02-12-dsp-downward-compatibility/README.md

@@ -0,0 +1,42 @@
+# Handling of downward compatibility for a DSP version
+
+## Decision
+
+For a given DSP protocol version *N*, there is no restriction concerning backward compatibility towards the previous
+versions (*N-1*) implementation of the DSP protocol.
+
+During the support of a certain DSP version *N*, the implementation has to be strictly backward compatible, i.e.,
+for two successive connector versions *X-1* and *X* that support both the DSP version *N*, if one participant changes
+from connector version *X-1* to version *X*, any interaction with connector version *X-1* is kept intact and has no
+breaking behavior. Additions to exchanged data models are in general not seen as breaking changes.
+
+## Rationale
+
+In general, the breaking change requirement of Catena-X has to be fulfilled as expressed in the
+[Operating model](https://catenax-ev.github.io/docs/operating-model/how-life-cycle-management). The requirement states
+that a dataspace participant can continuously exchange data with another participant without the need to be forced to
+update his system due to a change of the other participants service stack. This requires that data sent between
+consumer and provider must not change in a breaking fashion.
+
+A backward compatibility contraint between DSP versions is neither needed nor possible over time, as
+
+1. a dataspace participant should be able to control the connector version to use in his stack independently
+   from other participants, as long as that version implements the DSP version(s) required by the dataspace
+   at that point. If all required DSP version(s) are supported, there is no need for a backward compatibility 
+   constraint. Communication is still possible through previous DSP version(s).
+2. the DSP protocol and its upstream implementation does not support such a backward compatibility. To weaken the
+   impact of a missing upstream backward compatibility would require a substantial effort with a high risk of not
+   being able to compensate breaking changes. In summary, that is not a valid option.
+
+## Approach
+
+- The compatibility tests are enriched by tests that ensure the detection of breaking changes in relevant data models
+  defined by the DSP protocol.
+  This is achieved by tests which compare the returned data models to an expected result of the data model. There are
+  two options to use for the comparison of exchanged data models:
+  - For simpler data models, the expected data model is a handcrafted instance of the model that contains the minimum
+    properties expected and the comparison checks that the returned data model is a superset of the expected model.
+  - For more complex data models that are build deterministically, the expected result is recorded in an initial test
+    run and later test executions are compared to the recorded model. If a mismatch occurs, the returned data model
+    is compared to the expectation and if the change is reasonable the expected data model is recorded again to reflect
+    the now relevant changes.