Upgrade Notification

[michaelquigley]

Can we change the /api/v1/version protocol to provoke an upgrade message, even for older clients?

[michaelquigley]

For v1.0.0 we can alter the /api/v1/version GET method to return an out of date message, rather than a proper version. The protocol will shift such that /api/v1/version accepts a POST, which validates the client version for compatibility, which is probably a better long-term solution, as it gives the server side control over what client versions are compatible.

Existing zrok clients will receive an error message like this:

$ zrok04 share public -b web .
[ERROR]: unable to create share (error getting zrok client: expected a 'v0.4' version, received: 'your zrok version is out of date and needs to be upgraded! please visit 'https://github.com/openziti/zrok/releases' for the latest build!')

The v1.x releases will maintain the old GET endpoint, which will continue to provoke out-of-date clients to upgrade until we version the entire spec, at which point it could be removed.