Upgrade Guide
Upgrading from v6 to v7
CFHttp HTTP Client
This client now returns more accurate status codes for 502 Bad Gateway
and 408 Request Timeout
responses.
If you were previously checking specifically for 504
status codes for bad hosts, you need to now either check for 502
status codes or use a more general method, like isServerError
or isError
.
If you were previously checking specifically for 504
status codes or isServerError
for timed out requests, you need to now either check for 408
status codes, isClientError
, or the more general isError
.
Upgrading from v5 to v6
Dropped support for Adobe 2016.
Upgrading from v4 to v5
HyperHttpClientInterface
now requires a debug
method.
/**
* Return a struct of information showing how the client will execute the HyperRequest.
* This will be used by a developer to debug any differences between the generated
* request values and the expected request values.
*
* @req The HyperRequest to debug.
*
* @returns A struct of information detailing how the client would execute the HyperRequest.
*/
public struct function debug( required HyperRequest req );
Upgrading from v3 to v4
Previously, query params were stored as a struct. Some APIs expect multiple values for the same query param name to be passed as separate arguments. Hyper now stores the query params as an array and provides new methods for interacting with query params:
The following methods still exist, but now interact with arrays of query param structs instead of a simple struct.
The following methods have been deprecated:
Upgrading from v2 to v3
Dropped support for ColdBox 5.
Upgrading from v1 to v2
Dropped support for Lucee 4.5.