Document stricter REST API URL validation in Zeebe Java client

[koevskinikola]

Description

The Zeebe Java client uses Apache HttpClient5 to interact with the Zeebe cluster via REST API. A new version (5.3) of a component of the Apache HttpClient5 introduced stricter validations of REST API URIs (see PR).

Unfortunately, due to the design of the Zeebe Java client configuration API, any errors that come out of these stricter HttpClient5 validations have to be delegated to the Zeebe Java client users, i.e. users need to handle any badly formatted URIs themselves.

For a URI to pass validation, the URI needs to contain at least the following components: sheme://host:port. If a user passed a REST API URL in the format host:port, or a scheme that isn't http or https, the validation will fail.

We should document this change in our upgrade guide, once the impacting PR is merged.

AC

• The PR with stricter validations is merged.
• The stricter URI validations of the Zeebe Java client are documented in our announcements page.
  • REST API URI in the format sheme://host:port.
  • URI scheme is one of [http, https]