backend icon indicating copy to clipboard operation
backend copied to clipboard

API breaking changes without updating version number in routes

Open andyboyd opened this issue 4 years ago • 1 comments

Since the DeSo rebrand, several fields on API responses have changed, e.g. a field on get-exchange-rate has gone from SatoshisPerBitcloutExchangeRate to SatoshisPerDeSoExchangeRate. The same is true for many fields across many responses that referenced the word "Bitclout".

This in itself is fine, but the routes are still set up as /api/v0/:endpoint, meaning it's not possible to deploy the latest version of the core/backend code without breaking any apps using the node.

The routes should make proper use of the version number, maintain /v0 using the Bitclout field names, and use v1 for the renamed DeSo fields.

andyboyd avatar Sep 28 '21 13:09 andyboyd

agree - ive run into this on a few services I run.

Note that v1 is currently in use for exchange api calls like /block. https://docs.deso.org/devs/exchange-listing-api#full-api-guide

tijno avatar Sep 28 '21 14:09 tijno