Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API versioning #57

Open
jshencode opened this issue Jan 24, 2019 · 2 comments
Open

API versioning #57

jshencode opened this issue Jan 24, 2019 · 2 comments
Labels
enhancement New feature or request

Comments

@jshencode
Copy link
Contributor

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 jshencode added the enhancement New feature or request label Jan 24, 2019
@lucafuji
Copy link
Contributor

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

@linkerlin
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@linkerlin @lucafuji @jshencode