Skip to content

manager API: versioning

I think it's quite unlikely that manager's HTTP API will have flawless design from the start. At some point in the future, there might be a need to make a new backwards incompatible API. I think we should prepare for it now as it's still not too late and it's really easy to do so now.

Ideas

  • version in URL path (/config/v2/...)
  • version in the configuration (that would allow us to change the schema, but not the API itself)
  • version in HTTP header (probably something like X-API-Version: latest or X-API-Version: 6.0.0)
  • ...
Edited by Vaclav Sraier
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information