Skip to content

Commit 227cb9e

Browse files
authored
Merge pull request #5231 from zUniQueX/2.1-migration-guide
Add notes for breaking changes in Jersey and Liquibase
2 parents baffcd0 + af47303 commit 227cb9e

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

docs/source/manual/upgrade-notes/upgrade-notes-2_1_x.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,47 @@ Changed Configuration Options
5757
-----------------------------
5858
* ``delayedShutdownHandlerEnabled`` default value changed to ``false``.
5959
* ``servlet`` removed in favor of the new ``responder`` and ``responseProvider`` factories.
60+
61+
.. _upgrade-notes-dropwizard-2_1_x-breaking-changes:
62+
63+
Changes in versioning
64+
=====================
65+
Although Dropwizard tries to postpone big changes to major releases, some breaking changes had to be introduced into Dropwizard 2.1. This change is necessary due to new versioning of Dropwizard releases.
66+
The Dropwizard 2.x releases will stay on a Java 8 baseline and the ``javax`` namespace.
67+
Dropwizard 3.x will stay on the ``javax`` namespace too, but will drop support for Java 8 and upgrade to Java 11 instead.
68+
Dropwizard 4.x will eventually mirror the 3.x versions on the ``jakarta`` namespace and maybe introduce some more changes.
69+
70+
Therefore major updates for the Java 8 baseline have to be brought to minor releases on the 2.x branch. The major changes introduced in 2.1 are the following:
71+
72+
.. include:: <isonum.txt>
73+
74+
=================== ====================
75+
Library Version change
76+
=================== ====================
77+
argparse 0.8.x |rarr| 0.9.x
78+
79+
Hibernate Validator 6.1.x |rarr| 6.2.x
80+
81+
Jackson 2.10.x |rarr| 2.13.x
82+
83+
Jersey 2.33 |rarr| 2.35
84+
85+
Liquibase 3.10.x |rarr| 4.9.x
86+
87+
Dropwizard Metrics 4.1.x |rarr| 4.2.x
88+
=================== ====================
89+
90+
Upgrade to Liquibase 4.x
91+
------------------------
92+
Most of the updates come with low migration cost, but Liquibase gets a major version upgrade and needs some attention.
93+
94+
Liquibase 4.x changes the way it finds files. This means previously recognized migration files could be reported as missing.
95+
Liquibase lets users of the library specify paths, where it should search for files.
96+
Dropwizard therefore adds the file system specific roots to these ``root paths``, as well as the code location (of the current JAR).
97+
98+
This essentially means migration files now must be specified with absolute paths or be located under ``src/main/resources`` and specified relative to that path.
99+
100+
Upgrade to Jersey 2.35
101+
----------------------
102+
The upgrade of Jersey from version 2.33 to 2.35 introduces a behavior change in the handling of ``Optional<T>`` parameters.
103+
If such a parameter is invalid, now a status code ``404`` is returned instead of the former ``400`` status code.

0 commit comments

Comments
 (0)