http-json needs API versioning support for future/backwards compatibility

digital-asset / daml

The Daml smart contract language

https://www.digitalasset.com/developers

797 stars 199 forks source link

http-json needs API versioning support for future/backwards compatibility #3145

Closed lima-da closed 4 years ago

lima-da commented 4 years ago

When client is relying on certain version of API, and some “major” changes are introduced to the payload/error-handling, we need some versioning mechanism(uri/header) to prevent client failure

leo-da commented 4 years ago

@lima-da HTTP JSON API is still considered experimental. We do not yet want to commit to freezing the API. I would recommend DABL handle the versioning on its side for now. Once HTTP JSON API is stabilized we will get back to this issue.

CC @bame-da

leo-da commented 4 years ago

@hurryabit I assume we don't want to use semantic versioning in the JSON API URL? Don't really need the patch version.

What is it going to be <major>.<minor> or just <major>?

/v1/create, /v1/search.... or
/v1.0/create, /v1.0/search.

hurryabit commented 4 years ago

@leo-da I'm fine with having just a major version.