aresdb icon indicating copy to clipboard operation
aresdb copied to clipboard
verified publisher icon uber

API versioning

Open jshencode opened this issue 7 years ago • 2 comments

Is your feature request related to a problem? Please describe. currently our api is not versioned, this leads to risk in API updates, eg. ingestion upsert batch update or query response update

Describe the solution you'd like Common api versioning strategies:

  1. Version by URL path (ex: /api/v1/foo)
  2. Version by URL query string (ex: /api/foo?api-version=1.0)
  3. Version by HTTP header (ex: api-version: 1.0)
  4. Version by media type negotiation (ex: accept: application/vnd.mycompany.myapp-v2+xml)

jshencode avatar Jan 24 '19 23:01 jshencode

we might worry about this later since as of now the API client of AresDB is also controlled by us. we might be better to ensure the upgrade is backward-compatible instead of make breaking changes

lucafuji avatar Jan 30 '19 18:01 lucafuji

In the view of LTE, API version in URL is needed.

linkerlin avatar Oct 24 '19 06:10 linkerlin