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.

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

Semantic versioning #142

Open
osteele opened this issue Apr 14, 2018 · 0 comments
Open

Semantic versioning #142

osteele opened this issue Apr 14, 2018 · 0 comments
Labels
api Issues that affect the ABE API clients

Comments

@osteele
Copy link
Contributor

osteele commented Apr 14, 2018

Design a process for handling the breaking protocol changes in #135, #140. If it's flag day, write up a plan so that we can execute it. If it's one of the others, document it (and add supporting code, if any), so that we can re-use it or start form that for the next round of breaking changes.

This could be:

  • Add a version flag to the request. Listed for completeness.
  • Add a /v2 prefix. This is a widely-used pattern.
  • Two-phase deprecation. Add the new flags to the server; deploy; modify the client; deploy; remove the old flags from the server; deploy at leisure.
  • Flag day — everyone must upgrade. This requires inter-team coordination, coordinating multi-app deployments, and some downtime.
@osteele osteele created this issue from a note in Roadmap (Sprint Backlog) Apr 14, 2018
@osteele osteele added the api Issues that affect the ABE API clients label Apr 23, 2018
@osteele osteele added this to the Community Friday milestone Apr 25, 2018
@osteele osteele removed this from Sprint Backlog in Roadmap May 10, 2018
@osteele osteele removed this from the Community Friday milestone May 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Issues that affect the ABE API clients
Projects
None yet
Development

No branches or pull requests

1 participant