FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

openapi-java-migration/migration-notes at main · unblu/openapi-java-migration · GitHub

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Migration notes

One note per pair of consecutive released versions of the Unblu java client, describing what changed for calling code and what has to be done about it.

The clients are com.unblu.openapi:jersey3-client-v4 and com.unblu.openapi:models-v4, released from unblu/openapi.

The REST API is kept backward compatible; the generated java client is not. A release can leave the wire format untouched and still change a method signature or rename a class, because the client is generated from the specification and no compatibility overloads are kept. That is what these notes are for.

To upgrade across several releases, read every note between your current version and your target: each one is independent and they compose.

Pair Java code must change What changed
8.0.1 → 8.1.2 yes The expand parameter changed type on every operation that has one.
8.1.2 → 8.2.0 no change
8.2.0 → 8.3.1 yes Canned responses can no longer be searched on the key field.
8.3.1 → 8.4.2 yes One offboarding reason was removed.
8.4.2 → 8.5.0 no change
8.5.0 → 8.6.0 no change
8.6.0 → 8.6.1 no change
8.6.1 → 8.7.0 yes Persons can no longer be searched by label name.
8.7.0 → 8.8.1 no change
8.8.1 → 8.8.2 yes The deputy escalation level enum was replaced.
8.8.2 → 8.9.2 yes An external messenger channel property was removed.
8.9.2 → 8.10.1 no change
8.10.1 → 8.11.1 no change
8.11.1 → 8.12.1 no change
8.12.1 → 8.13.1 no change
8.13.1 → 8.14.4 yes SuggestionSourceData became an interface.
8.14.4 → 8.15.3 yes DialogBotData became an interface.
8.15.3 → 8.16.2 no change
8.16.2 → 8.17.1 yes The autoOpen flag of a branch client link was split in three.
8.17.1 → 8.18.0 yes The auxiliary camera type enum was renamed.
8.18.0 → 8.19.1 no change
8.19.1 → 8.20.2 no change
8.20.2 → 8.21.0 no change
8.21.0 → 8.22.1 yes The branch operations gained an expand parameter, and the floor plan moved.
8.22.1 → 8.23.2 no change
8.23.2 → 8.24.0 no change
8.24.0 → 8.25.1 no Documentation only.
8.25.1 → 8.26.2 yes The "try a summary template" operation was removed.
8.26.2 → 8.27.2 yes A message translation property was renamed.
8.27.2 → 8.28.4 no Documentation only.
8.28.4 → 8.29.1 no change
8.29.1 → 8.30.1 no change
8.30.1 → 8.31.2 no change
8.31.2 → 8.32.2 yes One message type was removed.
8.32.2 → 8.32.3 no change
8.32.3 → 8.33.3 no change
8.33.3 → 8.34.1 no Documentation only.
8.34.1 → 8.35.2 no change
8.35.2 → 8.36.1 no change
8.36.1 → 8.37.2 yes Bot and suggestion source operations gained an expand parameter; the bot webhook payload classes were removed.
8.37.2 → 8.38.2 yes Two WhatsApp template enums were renamed to fix a spelling mistake.
8.38.2 → 8.39.3 no change
8.39.3 → 8.40.4 yes The "person label" vocabulary was renamed to "label".

17 of the 43 releases require a change to java code. The remaining 26 are a version bump.

Each note links to the working examples in examples/ that demonstrate the break: every one of them compiles against the older client and fails to compile against the newer one, so the migration can be checked rather than assumed.


Back | FazBrowse Home | New Git URL