crc icon indicating copy to clipboard operation
crc copied to clipboard

Add versioning for http API

Open guillaumerose opened this issue 3 years ago • 4 comments

Now that we can remove the binary protocol and the http API is used by both tray, it might be a good idea to introduce versionned API.

The proposition is to copy the current http API under /v1 for instance. The next breaking change could use /v2, and so on.

guillaumerose avatar Jul 07 '21 07:07 guillaumerose

Ideally we'd never break the API, only extend it. However, we already have a plan to rework the current HTTP API, with probably breaking changes, so that will be a good time to also move it under the v1/ umbrella. With our fast release cycle, I don't know how to best approach this though, ideally we'd avoid releasing with /v1 while the API is still being reworked and we cannot commit to it being stable.

cfergeau avatar Jul 07 '21 08:07 cfergeau

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Sep 05 '21 21:09 stale[bot]

We're still in the process of breaking the API, so this is still valid.

cfergeau avatar Sep 06 '21 11:09 cfergeau

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Nov 06 '21 18:11 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Jan 08 '22 23:01 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Mar 19 '22 05:03 stale[bot]

The HTTP API still isn't finalized/frozen, and I don't think we've added versioning to it yet.

cfergeau avatar Mar 21 '22 08:03 cfergeau

@anjannath how is this solved?

gbraad avatar Jul 18 '22 10:07 gbraad

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Sep 20 '22 21:09 stale[bot]